3 * Global functions used everywhere.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 if ( !defined( 'MEDIAWIKI' ) ) {
24 die( "This file is part of MediaWiki, it is not a valid entry point" );
27 // Hide compatibility functions from Doxygen
31 * Compatibility functions
33 * We support PHP 5.3.2 and up.
34 * Re-implementations of newer functions or functions in non-standard
35 * PHP extensions may be included here.
38 if ( !function_exists( 'iconv' ) ) {
43 function iconv( $from, $to, $string ) {
44 return Fallback
::iconv( $from, $to, $string );
48 if ( !function_exists( 'mb_substr' ) ) {
53 function mb_substr( $str, $start, $count = 'end' ) {
54 return Fallback
::mb_substr( $str, $start, $count );
61 function mb_substr_split_unicode( $str, $splitPos ) {
62 return Fallback
::mb_substr_split_unicode( $str, $splitPos );
66 if ( !function_exists( 'mb_strlen' ) ) {
71 function mb_strlen( $str, $enc = '' ) {
72 return Fallback
::mb_strlen( $str, $enc );
76 if ( !function_exists( 'mb_strpos' ) ) {
81 function mb_strpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
82 return Fallback
::mb_strpos( $haystack, $needle, $offset, $encoding );
87 if ( !function_exists( 'mb_strrpos' ) ) {
92 function mb_strrpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
93 return Fallback
::mb_strrpos( $haystack, $needle, $offset, $encoding );
97 // gzdecode function only exists in PHP >= 5.4.0
98 // http://php.net/gzdecode
99 if ( !function_exists( 'gzdecode' ) ) {
101 * @codeCoverageIgnore
104 function gzdecode( $data ) {
105 return gzinflate( substr( $data, 10, -8 ) );
111 * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
116 function wfArrayDiff2( $a, $b ) {
117 return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
121 * @param $a array|string
122 * @param $b array|string
125 function wfArrayDiff2_cmp( $a, $b ) {
126 if ( is_string( $a ) && is_string( $b ) ) {
127 return strcmp( $a, $b );
128 } elseif ( count( $a ) !== count( $b ) ) {
129 return count( $a ) < count( $b ) ?
-1 : 1;
133 while ( ( list( , $valueA ) = each( $a ) ) && ( list( , $valueB ) = each( $b ) ) ) {
134 $cmp = strcmp( $valueA, $valueB );
145 * Returns an array where the values in array $b are replaced by the
146 * values in array $a with the corresponding keys
148 * @deprecated since 1.22; use array_intersect_key()
153 function wfArrayLookup( $a, $b ) {
154 wfDeprecated( __FUNCTION__
, '1.22' );
155 return array_flip( array_intersect( array_flip( $a ), array_keys( $b ) ) );
159 * Appends to second array if $value differs from that in $default
161 * @param $key String|Int
162 * @param $value Mixed
163 * @param $default Mixed
164 * @param array $changed to alter
165 * @throws MWException
167 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
168 if ( is_null( $changed ) ) {
169 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
171 if ( $default[$key] !== $value ) {
172 $changed[$key] = $value;
177 * Backwards array plus for people who haven't bothered to read the PHP manual
178 * XXX: will not darn your socks for you.
180 * @deprecated since 1.22; use array_replace()
181 * @param $array1 Array
182 * @param [$array2, [...]] Arrays
185 function wfArrayMerge( $array1/* ... */ ) {
186 wfDeprecated( __FUNCTION__
, '1.22' );
187 $args = func_get_args();
188 $args = array_reverse( $args, true );
190 foreach ( $args as $arg ) {
197 * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
199 * wfMergeErrorArrays(
200 * array( array( 'x' ) ),
201 * array( array( 'x', '2' ) ),
202 * array( array( 'x' ) ),
203 * array( array( 'y' ) )
214 function wfMergeErrorArrays( /*...*/ ) {
215 $args = func_get_args();
217 foreach ( $args as $errors ) {
218 foreach ( $errors as $params ) {
219 # @todo FIXME: Sometimes get nested arrays for $params,
220 # which leads to E_NOTICEs
221 $spec = implode( "\t", $params );
222 $out[$spec] = $params;
225 return array_values( $out );
229 * Insert array into another array after the specified *KEY*
231 * @param array $array The array.
232 * @param array $insert The array to insert.
233 * @param $after Mixed: The key to insert after
236 function wfArrayInsertAfter( array $array, array $insert, $after ) {
237 // Find the offset of the element to insert after.
238 $keys = array_keys( $array );
239 $offsetByKey = array_flip( $keys );
241 $offset = $offsetByKey[$after];
243 // Insert at the specified offset
244 $before = array_slice( $array, 0, $offset +
1, true );
245 $after = array_slice( $array, $offset +
1, count( $array ) - $offset, true );
247 $output = $before +
$insert +
$after;
253 * Recursively converts the parameter (an object) to an array with the same data
255 * @param $objOrArray Object|Array
256 * @param $recursive Bool
259 function wfObjectToArray( $objOrArray, $recursive = true ) {
261 if ( is_object( $objOrArray ) ) {
262 $objOrArray = get_object_vars( $objOrArray );
264 foreach ( $objOrArray as $key => $value ) {
265 if ( $recursive && ( is_object( $value ) ||
is_array( $value ) ) ) {
266 $value = wfObjectToArray( $value );
269 $array[$key] = $value;
276 * Get a random decimal value between 0 and 1, in a way
277 * not likely to give duplicate values for any realistic
278 * number of articles.
282 function wfRandom() {
283 # The maximum random value is "only" 2^31-1, so get two random
284 # values to reduce the chance of dupes
285 $max = mt_getrandmax() +
1;
286 $rand = number_format( ( mt_rand() * $max +
mt_rand() )
287 / $max / $max, 12, '.', '' );
292 * Get a random string containing a number of pseudo-random hex
294 * @note This is not secure, if you are trying to generate some sort
295 * of token please use MWCryptRand instead.
297 * @param int $length The length of the string to generate
301 function wfRandomString( $length = 32 ) {
303 for ( $n = 0; $n < $length; $n +
= 7 ) {
304 $str .= sprintf( '%07x', mt_rand() & 0xfffffff );
306 return substr( $str, 0, $length );
310 * We want some things to be included as literal characters in our title URLs
311 * for prettiness, which urlencode encodes by default. According to RFC 1738,
312 * all of the following should be safe:
316 * But + is not safe because it's used to indicate a space; &= are only safe in
317 * paths and not in queries (and we don't distinguish here); ' seems kind of
318 * scary; and urlencode() doesn't touch -_. to begin with. Plus, although /
319 * is reserved, we don't care. So the list we unescape is:
323 * However, IIS7 redirects fail when the url contains a colon (Bug 22709),
324 * so no fancy : for IIS7.
326 * %2F in the page titles seems to fatally break for some reason.
331 function wfUrlencode( $s ) {
333 if ( is_null( $s ) ) {
338 if ( is_null( $needle ) ) {
339 $needle = array( '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F' );
340 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false ) ) {
345 $s = urlencode( $s );
348 array( ';', '@', '$', '!', '*', '(', ')', ',', '/', ':' ),
356 * This function takes two arrays as input, and returns a CGI-style string, e.g.
357 * "days=7&limit=100". Options in the first array override options in the second.
358 * Options set to null or false will not be output.
360 * @param array $array1 ( String|Array )
361 * @param array $array2 ( String|Array )
362 * @param $prefix String
365 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
366 if ( !is_null( $array2 ) ) {
367 $array1 = $array1 +
$array2;
371 foreach ( $array1 as $key => $value ) {
372 if ( !is_null( $value ) && $value !== false ) {
376 if ( $prefix !== '' ) {
377 $key = $prefix . "[$key]";
379 if ( is_array( $value ) ) {
381 foreach ( $value as $k => $v ) {
382 $cgi .= $firstTime ?
'' : '&';
383 if ( is_array( $v ) ) {
384 $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
386 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
391 if ( is_object( $value ) ) {
392 $value = $value->__toString();
394 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
402 * This is the logical opposite of wfArrayToCgi(): it accepts a query string as
403 * its argument and returns the same string in array form. This allows compatibility
404 * with legacy functions that accept raw query strings instead of nice
405 * arrays. Of course, keys and values are urldecode()d.
407 * @param string $query query string
408 * @return array Array version of input
410 function wfCgiToArray( $query ) {
411 if ( isset( $query[0] ) && $query[0] == '?' ) {
412 $query = substr( $query, 1 );
414 $bits = explode( '&', $query );
416 foreach ( $bits as $bit ) {
420 if ( strpos( $bit, '=' ) === false ) {
421 // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
425 list( $key, $value ) = explode( '=', $bit );
427 $key = urldecode( $key );
428 $value = urldecode( $value );
429 if ( strpos( $key, '[' ) !== false ) {
430 $keys = array_reverse( explode( '[', $key ) );
431 $key = array_pop( $keys );
433 foreach ( $keys as $k ) {
434 $k = substr( $k, 0, -1 );
435 $temp = array( $k => $temp );
437 if ( isset( $ret[$key] ) ) {
438 $ret[$key] = array_merge( $ret[$key], $temp );
450 * Append a query string to an existing URL, which may or may not already
451 * have query string parameters already. If so, they will be combined.
454 * @param $query Mixed: string or associative array
457 function wfAppendQuery( $url, $query ) {
458 if ( is_array( $query ) ) {
459 $query = wfArrayToCgi( $query );
461 if ( $query != '' ) {
462 if ( false === strpos( $url, '?' ) ) {
473 * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer
476 * The meaning of the PROTO_* constants is as follows:
477 * PROTO_HTTP: Output a URL starting with http://
478 * PROTO_HTTPS: Output a URL starting with https://
479 * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL)
480 * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending on which protocol was used for the current incoming request
481 * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer. For protocol-relative URLs, use the protocol of $wgCanonicalServer
482 * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer
484 * @todo this won't work with current-path-relative URLs
485 * like "subdir/foo.html", etc.
487 * @param string $url either fully-qualified or a local path + query
488 * @param $defaultProto Mixed: one of the PROTO_* constants. Determines the
489 * protocol to use if $url or $wgServer is
491 * @return string Fully-qualified URL, current-path-relative URL or false if
492 * no valid URL can be constructed
494 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT
) {
495 global $wgServer, $wgCanonicalServer, $wgInternalServer;
496 $serverUrl = $wgServer;
497 if ( $defaultProto === PROTO_CANONICAL
) {
498 $serverUrl = $wgCanonicalServer;
500 // Make $wgInternalServer fall back to $wgServer if not set
501 if ( $defaultProto === PROTO_INTERNAL
&& $wgInternalServer !== false ) {
502 $serverUrl = $wgInternalServer;
504 if ( $defaultProto === PROTO_CURRENT
) {
505 $defaultProto = WebRequest
::detectProtocol() . '://';
508 // Analyze $serverUrl to obtain its protocol
509 $bits = wfParseUrl( $serverUrl );
510 $serverHasProto = $bits && $bits['scheme'] != '';
512 if ( $defaultProto === PROTO_CANONICAL ||
$defaultProto === PROTO_INTERNAL
) {
513 if ( $serverHasProto ) {
514 $defaultProto = $bits['scheme'] . '://';
516 // $wgCanonicalServer or $wgInternalServer doesn't have a protocol. This really isn't supposed to happen
517 // Fall back to HTTP in this ridiculous case
518 $defaultProto = PROTO_HTTP
;
522 $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
524 if ( substr( $url, 0, 2 ) == '//' ) {
525 $url = $defaultProtoWithoutSlashes . $url;
526 } elseif ( substr( $url, 0, 1 ) == '/' ) {
527 // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes, otherwise leave it alone
528 $url = ( $serverHasProto ?
'' : $defaultProtoWithoutSlashes ) . $serverUrl . $url;
531 $bits = wfParseUrl( $url );
532 if ( $bits && isset( $bits['path'] ) ) {
533 $bits['path'] = wfRemoveDotSegments( $bits['path'] );
534 return wfAssembleUrl( $bits );
538 } elseif ( substr( $url, 0, 1 ) != '/' ) {
539 # URL is a relative path
540 return wfRemoveDotSegments( $url );
543 # Expanded URL is not valid.
548 * This function will reassemble a URL parsed with wfParseURL. This is useful
549 * if you need to edit part of a URL and put it back together.
551 * This is the basic structure used (brackets contain keys for $urlParts):
552 * [scheme][delimiter][user]:[pass]@[host]:[port][path]?[query]#[fragment]
554 * @todo Need to integrate this into wfExpandUrl (bug 32168)
557 * @param array $urlParts URL parts, as output from wfParseUrl
558 * @return string URL assembled from its component parts
560 function wfAssembleUrl( $urlParts ) {
563 if ( isset( $urlParts['delimiter'] ) ) {
564 if ( isset( $urlParts['scheme'] ) ) {
565 $result .= $urlParts['scheme'];
568 $result .= $urlParts['delimiter'];
571 if ( isset( $urlParts['host'] ) ) {
572 if ( isset( $urlParts['user'] ) ) {
573 $result .= $urlParts['user'];
574 if ( isset( $urlParts['pass'] ) ) {
575 $result .= ':' . $urlParts['pass'];
580 $result .= $urlParts['host'];
582 if ( isset( $urlParts['port'] ) ) {
583 $result .= ':' . $urlParts['port'];
587 if ( isset( $urlParts['path'] ) ) {
588 $result .= $urlParts['path'];
591 if ( isset( $urlParts['query'] ) ) {
592 $result .= '?' . $urlParts['query'];
595 if ( isset( $urlParts['fragment'] ) ) {
596 $result .= '#' . $urlParts['fragment'];
603 * Remove all dot-segments in the provided URL path. For example,
604 * '/a/./b/../c/' becomes '/a/c/'. For details on the algorithm, please see
605 * RFC3986 section 5.2.4.
607 * @todo Need to integrate this into wfExpandUrl (bug 32168)
609 * @param string $urlPath URL path, potentially containing dot-segments
610 * @return string URL path with all dot-segments removed
612 function wfRemoveDotSegments( $urlPath ) {
615 $inputLength = strlen( $urlPath );
617 while ( $inputOffset < $inputLength ) {
618 $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
619 $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
620 $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
621 $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
624 if ( $prefixLengthTwo == './' ) {
625 # Step A, remove leading "./"
627 } elseif ( $prefixLengthThree == '../' ) {
628 # Step A, remove leading "../"
630 } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset +
2 == $inputLength ) ) {
631 # Step B, replace leading "/.$" with "/"
633 $urlPath[$inputOffset] = '/';
634 } elseif ( $prefixLengthThree == '/./' ) {
635 # Step B, replace leading "/./" with "/"
637 } elseif ( $prefixLengthThree == '/..' && ( $inputOffset +
3 == $inputLength ) ) {
638 # Step C, replace leading "/..$" with "/" and
639 # remove last path component in output
641 $urlPath[$inputOffset] = '/';
643 } elseif ( $prefixLengthFour == '/../' ) {
644 # Step C, replace leading "/../" with "/" and
645 # remove last path component in output
648 } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset +
1 == $inputLength ) ) {
649 # Step D, remove "^.$"
651 } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset +
2 == $inputLength ) ) {
652 # Step D, remove "^..$"
655 # Step E, move leading path segment to output
656 if ( $prefixLengthOne == '/' ) {
657 $slashPos = strpos( $urlPath, '/', $inputOffset +
1 );
659 $slashPos = strpos( $urlPath, '/', $inputOffset );
661 if ( $slashPos === false ) {
662 $output .= substr( $urlPath, $inputOffset );
663 $inputOffset = $inputLength;
665 $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
666 $inputOffset +
= $slashPos - $inputOffset;
671 $slashPos = strrpos( $output, '/' );
672 if ( $slashPos === false ) {
675 $output = substr( $output, 0, $slashPos );
684 * Returns a regular expression of url protocols
686 * @param bool $includeProtocolRelative If false, remove '//' from the returned protocol list.
687 * DO NOT USE this directly, use wfUrlProtocolsWithoutProtRel() instead
690 function wfUrlProtocols( $includeProtocolRelative = true ) {
691 global $wgUrlProtocols;
693 // Cache return values separately based on $includeProtocolRelative
694 static $withProtRel = null, $withoutProtRel = null;
695 $cachedValue = $includeProtocolRelative ?
$withProtRel : $withoutProtRel;
696 if ( !is_null( $cachedValue ) ) {
700 // Support old-style $wgUrlProtocols strings, for backwards compatibility
701 // with LocalSettings files from 1.5
702 if ( is_array( $wgUrlProtocols ) ) {
703 $protocols = array();
704 foreach ( $wgUrlProtocols as $protocol ) {
705 // Filter out '//' if !$includeProtocolRelative
706 if ( $includeProtocolRelative ||
$protocol !== '//' ) {
707 $protocols[] = preg_quote( $protocol, '/' );
711 $retval = implode( '|', $protocols );
713 // Ignore $includeProtocolRelative in this case
714 // This case exists for pre-1.6 compatibility, and we can safely assume
715 // that '//' won't appear in a pre-1.6 config because protocol-relative
716 // URLs weren't supported until 1.18
717 $retval = $wgUrlProtocols;
720 // Cache return value
721 if ( $includeProtocolRelative ) {
722 $withProtRel = $retval;
724 $withoutProtRel = $retval;
730 * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
731 * you need a regex that matches all URL protocols but does not match protocol-
735 function wfUrlProtocolsWithoutProtRel() {
736 return wfUrlProtocols( false );
740 * parse_url() work-alike, but non-broken. Differences:
742 * 1) Does not raise warnings on bad URLs (just returns false)
743 * 2) Handles protocols that don't use :// (e.g., mailto: and news: , as well as protocol-relative URLs) correctly
744 * 3) Adds a "delimiter" element to the array, either '://', ':' or '//' (see (2))
746 * @param string $url a URL to parse
747 * @return Array: bits of the URL in an associative array, per PHP docs
749 function wfParseUrl( $url ) {
750 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
752 // Protocol-relative URLs are handled really badly by parse_url(). It's so bad that the easiest
753 // way to handle them is to just prepend 'http:' and strip the protocol out later
754 $wasRelative = substr( $url, 0, 2 ) == '//';
755 if ( $wasRelative ) {
758 wfSuppressWarnings();
759 $bits = parse_url( $url );
761 // parse_url() returns an array without scheme for some invalid URLs, e.g.
762 // parse_url("%0Ahttp://example.com") == array( 'host' => '%0Ahttp', 'path' => 'example.com' )
763 if ( !$bits ||
!isset( $bits['scheme'] ) ) {
767 // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
768 $bits['scheme'] = strtolower( $bits['scheme'] );
770 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
771 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
772 $bits['delimiter'] = '://';
773 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
774 $bits['delimiter'] = ':';
775 // parse_url detects for news: and mailto: the host part of an url as path
776 // We have to correct this wrong detection
777 if ( isset( $bits['path'] ) ) {
778 $bits['host'] = $bits['path'];
785 /* Provide an empty host for eg. file:/// urls (see bug 28627) */
786 if ( !isset( $bits['host'] ) ) {
790 if ( isset( $bits['path'] ) ) {
791 /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
792 if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
793 $bits['path'] = '/' . $bits['path'];
800 // If the URL was protocol-relative, fix scheme and delimiter
801 if ( $wasRelative ) {
802 $bits['scheme'] = '';
803 $bits['delimiter'] = '//';
809 * Take a URL, make sure it's expanded to fully qualified, and replace any
810 * encoded non-ASCII Unicode characters with their UTF-8 original forms
811 * for more compact display and legibility for local audiences.
813 * @todo handle punycode domains too
818 function wfExpandIRI( $url ) {
819 return preg_replace_callback( '/((?:%[89A-F][0-9A-F])+)/i', 'wfExpandIRI_callback', wfExpandUrl( $url ) );
823 * Private callback for wfExpandIRI
824 * @param array $matches
827 function wfExpandIRI_callback( $matches ) {
828 return urldecode( $matches[1] );
832 * Make URL indexes, appropriate for the el_index field of externallinks.
837 function wfMakeUrlIndexes( $url ) {
838 $bits = wfParseUrl( $url );
840 // Reverse the labels in the hostname, convert to lower case
841 // For emails reverse domainpart only
842 if ( $bits['scheme'] == 'mailto' ) {
843 $mailparts = explode( '@', $bits['host'], 2 );
844 if ( count( $mailparts ) === 2 ) {
845 $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
847 // No domain specified, don't mangle it
850 $reversedHost = $domainpart . '@' . $mailparts[0];
852 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
854 // Add an extra dot to the end
855 // Why? Is it in wrong place in mailto links?
856 if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
857 $reversedHost .= '.';
859 // Reconstruct the pseudo-URL
860 $prot = $bits['scheme'];
861 $index = $prot . $bits['delimiter'] . $reversedHost;
862 // Leave out user and password. Add the port, path, query and fragment
863 if ( isset( $bits['port'] ) ) {
864 $index .= ':' . $bits['port'];
866 if ( isset( $bits['path'] ) ) {
867 $index .= $bits['path'];
871 if ( isset( $bits['query'] ) ) {
872 $index .= '?' . $bits['query'];
874 if ( isset( $bits['fragment'] ) ) {
875 $index .= '#' . $bits['fragment'];
879 return array( "http:$index", "https:$index" );
881 return array( $index );
886 * Check whether a given URL has a domain that occurs in a given set of domains
887 * @param string $url URL
888 * @param array $domains Array of domains (strings)
889 * @return bool True if the host part of $url ends in one of the strings in $domains
891 function wfMatchesDomainList( $url, $domains ) {
892 $bits = wfParseUrl( $url );
893 if ( is_array( $bits ) && isset( $bits['host'] ) ) {
894 $host = '.' . $bits['host'];
895 foreach ( (array)$domains as $domain ) {
896 $domain = '.' . $domain;
897 if ( substr( $host, -strlen( $domain ) ) === $domain ) {
906 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
907 * In normal operation this is a NOP.
909 * Controlling globals:
910 * $wgDebugLogFile - points to the log file
911 * $wgProfileOnly - if set, normal debug messages will not be recorded.
912 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
913 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
915 * @param $text String
916 * @param bool $logonly set true to avoid appearing in HTML when $wgDebugComments is set
918 function wfDebug( $text, $logonly = false ) {
919 global $wgDebugLogFile, $wgProfileOnly, $wgDebugRawPage, $wgDebugLogPrefix;
921 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
925 $timer = wfDebugTimer();
926 if ( $timer !== '' ) {
927 $text = preg_replace( '/[^\n]/', $timer . '\0', $text, 1 );
931 MWDebug
::debugMsg( $text );
934 if ( wfRunHooks( 'Debug', array( $text, null /* no log group */ ) ) ) {
935 if ( $wgDebugLogFile != '' && !$wgProfileOnly ) {
936 # Strip unprintables; they can switch terminal modes when binary data
937 # gets dumped, which is pretty annoying.
938 $text = preg_replace( '![\x00-\x08\x0b\x0c\x0e-\x1f]!', ' ', $text );
939 $text = $wgDebugLogPrefix . $text;
940 wfErrorLog( $text, $wgDebugLogFile );
946 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
949 function wfIsDebugRawPage() {
951 if ( $cache !== null ) {
954 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
955 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
957 isset( $_SERVER['SCRIPT_NAME'] )
958 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
969 * Get microsecond timestamps for debug logs
973 function wfDebugTimer() {
974 global $wgDebugTimestamps, $wgRequestTime;
976 if ( !$wgDebugTimestamps ) {
980 $prefix = sprintf( "%6.4f", microtime( true ) - $wgRequestTime );
981 $mem = sprintf( "%5.1fM", ( memory_get_usage( true ) / ( 1024 * 1024 ) ) );
982 return "$prefix $mem ";
986 * Send a line giving PHP memory usage.
988 * @param bool $exact print exact values instead of kilobytes (default: false)
990 function wfDebugMem( $exact = false ) {
991 $mem = memory_get_usage();
993 $mem = floor( $mem / 1024 ) . ' kilobytes';
997 wfDebug( "Memory usage: $mem\n" );
1001 * Send a line to a supplementary debug log file, if configured, or main debug log if not.
1002 * $wgDebugLogGroups[$logGroup] should be set to a filename to send to a separate log.
1004 * @param $logGroup String
1005 * @param $text String
1006 * @param bool $public whether to log the event in the public log if no private
1007 * log file is specified, (default true)
1009 function wfDebugLog( $logGroup, $text, $public = true ) {
1010 global $wgDebugLogGroups;
1011 $text = trim( $text ) . "\n";
1012 if ( isset( $wgDebugLogGroups[$logGroup] ) ) {
1013 $time = wfTimestamp( TS_DB
);
1015 $host = wfHostname();
1016 if ( wfRunHooks( 'Debug', array( $text, $logGroup ) ) ) {
1017 wfErrorLog( "$time $host $wiki: $text", $wgDebugLogGroups[$logGroup] );
1019 } elseif ( $public === true ) {
1020 wfDebug( "[$logGroup] $text", false );
1025 * Log for database errors
1027 * @param string $text database error message.
1029 function wfLogDBError( $text ) {
1030 global $wgDBerrorLog, $wgDBerrorLogTZ;
1031 static $logDBErrorTimeZoneObject = null;
1033 if ( $wgDBerrorLog ) {
1034 $host = wfHostname();
1037 if ( $wgDBerrorLogTZ && !$logDBErrorTimeZoneObject ) {
1038 $logDBErrorTimeZoneObject = new DateTimeZone( $wgDBerrorLogTZ );
1041 // Workaround for https://bugs.php.net/bug.php?id=52063
1042 // Can be removed when min PHP > 5.3.2
1043 if ( $logDBErrorTimeZoneObject === null ) {
1044 $d = date_create( "now" );
1046 $d = date_create( "now", $logDBErrorTimeZoneObject );
1049 $date = $d->format( 'D M j G:i:s T Y' );
1051 $text = "$date\t$host\t$wiki\t$text";
1052 wfErrorLog( $text, $wgDBerrorLog );
1057 * Throws a warning that $function is deprecated
1059 * @param $function String
1060 * @param string|bool $version Version of MediaWiki that the function was deprecated in (Added in 1.19).
1061 * @param string|bool $component Added in 1.19.
1062 * @param $callerOffset integer: How far up the call stack is the original
1063 * caller. 2 = function that called the function that called
1064 * wfDeprecated (Added in 1.20)
1068 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1069 MWDebug
::deprecated( $function, $version, $component, $callerOffset +
1 );
1073 * Send a warning either to the debug log or in a PHP error depending on
1074 * $wgDevelopmentWarnings. To log warnings in production, use wfLogWarning() instead.
1076 * @param string $msg message to send
1077 * @param $callerOffset Integer: number of items to go back in the backtrace to
1078 * find the correct caller (1 = function calling wfWarn, ...)
1079 * @param $level Integer: PHP error level; defaults to E_USER_NOTICE;
1080 * only used when $wgDevelopmentWarnings is true
1082 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
1083 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'auto' );
1087 * Send a warning as a PHP error and the debug log. This is intended for logging
1088 * warnings in production. For logging development warnings, use WfWarn instead.
1090 * @param $msg String: message to send
1091 * @param $callerOffset Integer: number of items to go back in the backtrace to
1092 * find the correct caller (1 = function calling wfLogWarning, ...)
1093 * @param $level Integer: PHP error level; defaults to E_USER_WARNING
1095 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING
) {
1096 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'production' );
1100 * Log to a file without getting "file size exceeded" signals.
1102 * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
1103 * send lines to the specified port, prefixed by the specified prefix and a space.
1105 * @param $text String
1106 * @param string $file filename
1107 * @throws MWException
1109 function wfErrorLog( $text, $file ) {
1110 if ( substr( $file, 0, 4 ) == 'udp:' ) {
1111 # Needs the sockets extension
1112 if ( preg_match( '!^(tcp|udp):(?://)?\[([0-9a-fA-F:]+)\]:(\d+)(?:/(.*))?$!', $file, $m ) ) {
1113 // IPv6 bracketed host
1115 $port = intval( $m[3] );
1116 $prefix = isset( $m[4] ) ?
$m[4] : false;
1118 } elseif ( preg_match( '!^(tcp|udp):(?://)?([a-zA-Z0-9.-]+):(\d+)(?:/(.*))?$!', $file, $m ) ) {
1120 if ( !IP
::isIPv4( $host ) ) {
1121 $host = gethostbyname( $host );
1123 $port = intval( $m[3] );
1124 $prefix = isset( $m[4] ) ?
$m[4] : false;
1127 throw new MWException( __METHOD__
. ': Invalid UDP specification' );
1130 // Clean it up for the multiplexer
1131 if ( strval( $prefix ) !== '' ) {
1132 $text = preg_replace( '/^/m', $prefix . ' ', $text );
1135 if ( strlen( $text ) > 65506 ) {
1136 $text = substr( $text, 0, 65506 );
1139 if ( substr( $text, -1 ) != "\n" ) {
1142 } elseif ( strlen( $text ) > 65507 ) {
1143 $text = substr( $text, 0, 65507 );
1146 $sock = socket_create( $domain, SOCK_DGRAM
, SOL_UDP
);
1151 socket_sendto( $sock, $text, strlen( $text ), 0, $host, $port );
1152 socket_close( $sock );
1154 wfSuppressWarnings();
1155 $exists = file_exists( $file );
1156 $size = $exists ?
filesize( $file ) : false;
1157 if ( !$exists ||
( $size !== false && $size +
strlen( $text ) < 0x7fffffff ) ) {
1158 file_put_contents( $file, $text, FILE_APPEND
);
1160 wfRestoreWarnings();
1167 function wfLogProfilingData() {
1168 global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest;
1169 global $wgProfileLimit, $wgUser;
1171 StatCounter
::singleton()->flush();
1173 $profiler = Profiler
::instance();
1175 # Profiling must actually be enabled...
1176 if ( $profiler->isStub() ) {
1180 // Get total page request time and only show pages that longer than
1181 // $wgProfileLimit time (default is 0)
1182 $elapsed = microtime( true ) - $wgRequestTime;
1183 if ( $elapsed <= $wgProfileLimit ) {
1187 $profiler->logData();
1189 // Check whether this should be logged in the debug file.
1190 if ( $wgDebugLogFile == '' ||
( !$wgDebugRawPage && wfIsDebugRawPage() ) ) {
1195 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1196 $forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR'];
1198 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1199 $forward .= ' client IP ' . $_SERVER['HTTP_CLIENT_IP'];
1201 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1202 $forward .= ' from ' . $_SERVER['HTTP_FROM'];
1205 $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
1207 // Don't load $wgUser at this late stage just for statistics purposes
1208 // @todo FIXME: We can detect some anons even if it is not loaded. See User::getId()
1209 if ( $wgUser->isItemLoaded( 'id' ) && $wgUser->isAnon() ) {
1210 $forward .= ' anon';
1213 // Command line script uses a FauxRequest object which does not have
1214 // any knowledge about an URL and throw an exception instead.
1216 $requestUrl = $wgRequest->getRequestURL();
1217 } catch ( MWException
$e ) {
1218 $requestUrl = 'n/a';
1221 $log = sprintf( "%s\t%04.3f\t%s\n",
1222 gmdate( 'YmdHis' ), $elapsed,
1223 urldecode( $requestUrl . $forward ) );
1225 wfErrorLog( $log . $profiler->getOutput(), $wgDebugLogFile );
1229 * Increment a statistics counter
1231 * @param $key String
1235 function wfIncrStats( $key, $count = 1 ) {
1236 StatCounter
::singleton()->incr( $key, $count );
1240 * Check whether the wiki is in read-only mode.
1244 function wfReadOnly() {
1245 return wfReadOnlyReason() !== false;
1249 * Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
1251 * @return string|bool: String when in read-only mode; false otherwise
1253 function wfReadOnlyReason() {
1254 global $wgReadOnly, $wgReadOnlyFile;
1256 if ( $wgReadOnly === null ) {
1257 // Set $wgReadOnly for faster access next time
1258 if ( is_file( $wgReadOnlyFile ) && filesize( $wgReadOnlyFile ) > 0 ) {
1259 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
1261 $wgReadOnly = false;
1269 * Return a Language object from $langcode
1271 * @param $langcode Mixed: either:
1272 * - a Language object
1273 * - code of the language to get the message for, if it is
1274 * a valid code create a language for that language, if
1275 * it is a string but not a valid code then make a basic
1277 * - a boolean: if it's false then use the global object for
1278 * the current user's language (as a fallback for the old parameter
1279 * functionality), or if it is true then use global object
1280 * for the wiki's content language.
1281 * @return Language object
1283 function wfGetLangObj( $langcode = false ) {
1284 # Identify which language to get or create a language object for.
1285 # Using is_object here due to Stub objects.
1286 if ( is_object( $langcode ) ) {
1287 # Great, we already have the object (hopefully)!
1291 global $wgContLang, $wgLanguageCode;
1292 if ( $langcode === true ||
$langcode === $wgLanguageCode ) {
1293 # $langcode is the language code of the wikis content language object.
1294 # or it is a boolean and value is true
1299 if ( $langcode === false ||
$langcode === $wgLang->getCode() ) {
1300 # $langcode is the language code of user language object.
1301 # or it was a boolean and value is false
1305 $validCodes = array_keys( Language
::fetchLanguageNames() );
1306 if ( in_array( $langcode, $validCodes ) ) {
1307 # $langcode corresponds to a valid language.
1308 return Language
::factory( $langcode );
1311 # $langcode is a string, but not a valid language code; use content language.
1312 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1317 * Old function when $wgBetterDirectionality existed
1318 * All usage removed, wfUILang can be removed in near future
1320 * @deprecated since 1.18
1323 function wfUILang() {
1324 wfDeprecated( __METHOD__
, '1.18' );
1330 * This is the function for getting translated interface messages.
1332 * @see Message class for documentation how to use them.
1333 * @see https://www.mediawiki.org/wiki/Manual:Messages_API
1335 * This function replaces all old wfMsg* functions.
1337 * @param $key \string Message key.
1338 * Varargs: normal message parameters.
1342 function wfMessage( $key /*...*/) {
1343 $params = func_get_args();
1344 array_shift( $params );
1345 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
1346 $params = $params[0];
1348 return new Message( $key, $params );
1352 * This function accepts multiple message keys and returns a message instance
1353 * for the first message which is non-empty. If all messages are empty then an
1354 * instance of the first message key is returned.
1355 * @param varargs: message keys
1359 function wfMessageFallback( /*...*/ ) {
1360 $args = func_get_args();
1361 return call_user_func_array( 'Message::newFallbackSequence', $args );
1365 * Get a message from anywhere, for the current user language.
1367 * Use wfMsgForContent() instead if the message should NOT
1368 * change depending on the user preferences.
1370 * @deprecated since 1.18
1372 * @param string $key lookup key for the message, usually
1373 * defined in languages/Language.php
1375 * Parameters to the message, which can be used to insert variable text into
1376 * it, can be passed to this function in the following formats:
1377 * - One per argument, starting at the second parameter
1378 * - As an array in the second parameter
1379 * These are not shown in the function definition.
1383 function wfMsg( $key ) {
1384 wfDeprecated( __METHOD__
, '1.21' );
1386 $args = func_get_args();
1387 array_shift( $args );
1388 return wfMsgReal( $key, $args );
1392 * Same as above except doesn't transform the message
1394 * @deprecated since 1.18
1396 * @param $key String
1399 function wfMsgNoTrans( $key ) {
1400 wfDeprecated( __METHOD__
, '1.21' );
1402 $args = func_get_args();
1403 array_shift( $args );
1404 return wfMsgReal( $key, $args, true, false, false );
1408 * Get a message from anywhere, for the current global language
1409 * set with $wgLanguageCode.
1411 * Use this if the message should NOT change dependent on the
1412 * language set in the user's preferences. This is the case for
1413 * most text written into logs, as well as link targets (such as
1414 * the name of the copyright policy page). Link titles, on the
1415 * other hand, should be shown in the UI language.
1417 * Note that MediaWiki allows users to change the user interface
1418 * language in their preferences, but a single installation
1419 * typically only contains content in one language.
1421 * Be wary of this distinction: If you use wfMsg() where you should
1422 * use wfMsgForContent(), a user of the software may have to
1423 * customize potentially hundreds of messages in
1424 * order to, e.g., fix a link in every possible language.
1426 * @deprecated since 1.18
1428 * @param string $key lookup key for the message, usually
1429 * defined in languages/Language.php
1432 function wfMsgForContent( $key ) {
1433 wfDeprecated( __METHOD__
, '1.21' );
1435 global $wgForceUIMsgAsContentMsg;
1436 $args = func_get_args();
1437 array_shift( $args );
1439 if ( is_array( $wgForceUIMsgAsContentMsg ) &&
1440 in_array( $key, $wgForceUIMsgAsContentMsg ) )
1442 $forcontent = false;
1444 return wfMsgReal( $key, $args, true, $forcontent );
1448 * Same as above except doesn't transform the message
1450 * @deprecated since 1.18
1452 * @param $key String
1455 function wfMsgForContentNoTrans( $key ) {
1456 wfDeprecated( __METHOD__
, '1.21' );
1458 global $wgForceUIMsgAsContentMsg;
1459 $args = func_get_args();
1460 array_shift( $args );
1462 if ( is_array( $wgForceUIMsgAsContentMsg ) &&
1463 in_array( $key, $wgForceUIMsgAsContentMsg ) )
1465 $forcontent = false;
1467 return wfMsgReal( $key, $args, true, $forcontent, false );
1471 * Really get a message
1473 * @deprecated since 1.18
1475 * @param string $key key to get.
1477 * @param $useDB Boolean
1478 * @param $forContent Mixed: Language code, or false for user lang, true for content lang.
1479 * @param $transform Boolean: Whether or not to transform the message.
1480 * @return String: the requested message.
1482 function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform = true ) {
1483 wfDeprecated( __METHOD__
, '1.21' );
1485 wfProfileIn( __METHOD__
);
1486 $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
1487 $message = wfMsgReplaceArgs( $message, $args );
1488 wfProfileOut( __METHOD__
);
1493 * Fetch a message string value, but don't replace any keys yet.
1495 * @deprecated since 1.18
1497 * @param $key String
1498 * @param $useDB Bool
1499 * @param string $langCode Code of the language to get the message for, or
1500 * behaves as a content language switch if it is a boolean.
1501 * @param $transform Boolean: whether to parse magic words, etc.
1504 function wfMsgGetKey( $key, $useDB = true, $langCode = false, $transform = true ) {
1505 wfDeprecated( __METHOD__
, '1.21' );
1507 wfRunHooks( 'NormalizeMessageKey', array( &$key, &$useDB, &$langCode, &$transform ) );
1509 $cache = MessageCache
::singleton();
1510 $message = $cache->get( $key, $useDB, $langCode );
1511 if ( $message === false ) {
1512 $message = '<' . htmlspecialchars( $key ) . '>';
1513 } elseif ( $transform ) {
1514 $message = $cache->transform( $message );
1520 * Replace message parameter keys on the given formatted output.
1522 * @param $message String
1523 * @param $args Array
1527 function wfMsgReplaceArgs( $message, $args ) {
1528 # Fix windows line-endings
1529 # Some messages are split with explode("\n", $msg)
1530 $message = str_replace( "\r", '', $message );
1532 // Replace arguments
1533 if ( count( $args ) ) {
1534 if ( is_array( $args[0] ) ) {
1535 $args = array_values( $args[0] );
1537 $replacementKeys = array();
1538 foreach ( $args as $n => $param ) {
1539 $replacementKeys['$' . ( $n +
1 )] = $param;
1541 $message = strtr( $message, $replacementKeys );
1548 * Return an HTML-escaped version of a message.
1549 * Parameter replacements, if any, are done *after* the HTML-escaping,
1550 * so parameters may contain HTML (eg links or form controls). Be sure
1551 * to pre-escape them if you really do want plaintext, or just wrap
1552 * the whole thing in htmlspecialchars().
1554 * @deprecated since 1.18
1556 * @param $key String
1557 * @param string ... parameters
1560 function wfMsgHtml( $key ) {
1561 wfDeprecated( __METHOD__
, '1.21' );
1563 $args = func_get_args();
1564 array_shift( $args );
1565 return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key ) ), $args );
1569 * Return an HTML version of message
1570 * Parameter replacements, if any, are done *after* parsing the wiki-text message,
1571 * so parameters may contain HTML (eg links or form controls). Be sure
1572 * to pre-escape them if you really do want plaintext, or just wrap
1573 * the whole thing in htmlspecialchars().
1575 * @deprecated since 1.18
1577 * @param $key String
1578 * @param string ... parameters
1581 function wfMsgWikiHtml( $key ) {
1582 wfDeprecated( __METHOD__
, '1.21' );
1584 $args = func_get_args();
1585 array_shift( $args );
1586 return wfMsgReplaceArgs(
1587 MessageCache
::singleton()->parse( wfMsgGetKey( $key ), null,
1588 /* can't be set to false */ true, /* interface */ true )->getText(),
1593 * Returns message in the requested format
1595 * @deprecated since 1.18
1597 * @param string $key key of the message
1598 * @param array $options processing rules. Can take the following options:
1599 * <i>parse</i>: parses wikitext to HTML
1600 * <i>parseinline</i>: parses wikitext to HTML and removes the surrounding
1601 * p's added by parser or tidy
1602 * <i>escape</i>: filters message through htmlspecialchars
1603 * <i>escapenoentities</i>: same, but allows entity references like   through
1604 * <i>replaceafter</i>: parameters are substituted after parsing or escaping
1605 * <i>parsemag</i>: transform the message using magic phrases
1606 * <i>content</i>: fetch message for content language instead of interface
1607 * Also can accept a single associative argument, of the form 'language' => 'xx':
1608 * <i>language</i>: Language object or language code to fetch message for
1609 * (overridden by <i>content</i>).
1610 * Behavior for conflicting options (e.g., parse+parseinline) is undefined.
1614 function wfMsgExt( $key, $options ) {
1615 wfDeprecated( __METHOD__
, '1.21' );
1617 $args = func_get_args();
1618 array_shift( $args );
1619 array_shift( $args );
1620 $options = (array)$options;
1622 foreach ( $options as $arrayKey => $option ) {
1623 if ( !preg_match( '/^[0-9]+|language$/', $arrayKey ) ) {
1624 # An unknown index, neither numeric nor "language"
1625 wfWarn( "wfMsgExt called with incorrect parameter key $arrayKey", 1, E_USER_WARNING
);
1626 } elseif ( preg_match( '/^[0-9]+$/', $arrayKey ) && !in_array( $option,
1627 array( 'parse', 'parseinline', 'escape', 'escapenoentities',
1628 'replaceafter', 'parsemag', 'content' ) ) ) {
1629 # A numeric index with unknown value
1630 wfWarn( "wfMsgExt called with incorrect parameter $option", 1, E_USER_WARNING
);
1634 if ( in_array( 'content', $options, true ) ) {
1637 $langCodeObj = null;
1638 } elseif ( array_key_exists( 'language', $options ) ) {
1639 $forContent = false;
1640 $langCode = wfGetLangObj( $options['language'] );
1641 $langCodeObj = $langCode;
1643 $forContent = false;
1645 $langCodeObj = null;
1648 $string = wfMsgGetKey( $key, /*DB*/true, $langCode, /*Transform*/false );
1650 if ( !in_array( 'replaceafter', $options, true ) ) {
1651 $string = wfMsgReplaceArgs( $string, $args );
1654 $messageCache = MessageCache
::singleton();
1655 $parseInline = in_array( 'parseinline', $options, true );
1656 if ( in_array( 'parse', $options, true ) ||
$parseInline ) {
1657 $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj );
1658 if ( $string instanceof ParserOutput
) {
1659 $string = $string->getText();
1662 if ( $parseInline ) {
1664 if ( preg_match( '/^<p>(.*)\n?<\/p>\n?$/sU', $string, $m ) ) {
1668 } elseif ( in_array( 'parsemag', $options, true ) ) {
1669 $string = $messageCache->transform( $string,
1670 !$forContent, $langCodeObj );
1673 if ( in_array( 'escape', $options, true ) ) {
1674 $string = htmlspecialchars ( $string );
1675 } elseif ( in_array( 'escapenoentities', $options, true ) ) {
1676 $string = Sanitizer
::escapeHtmlAllowEntities( $string );
1679 if ( in_array( 'replaceafter', $options, true ) ) {
1680 $string = wfMsgReplaceArgs( $string, $args );
1687 * Since wfMsg() and co suck, they don't return false if the message key they
1688 * looked up didn't exist but instead the key wrapped in <>'s, this function checks for the
1689 * nonexistence of messages by checking the MessageCache::get() result directly.
1691 * @deprecated since 1.18. Use Message::isDisabled().
1693 * @param $key String: the message key looked up
1694 * @return Boolean True if the message *doesn't* exist.
1696 function wfEmptyMsg( $key ) {
1697 wfDeprecated( __METHOD__
, '1.21' );
1699 return MessageCache
::singleton()->get( $key, /*useDB*/true, /*content*/false ) === false;
1703 * Throw a debugging exception. This function previously once exited the process,
1704 * but now throws an exception instead, with similar results.
1706 * @deprecated since 1.22; just throw an MWException yourself
1707 * @param string $msg message shown when dying.
1708 * @throws MWException
1710 function wfDebugDieBacktrace( $msg = '' ) {
1711 wfDeprecated( __FUNCTION__
, '1.22' );
1712 throw new MWException( $msg );
1716 * Fetch server name for use in error reporting etc.
1717 * Use real server name if available, so we know which machine
1718 * in a server farm generated the current page.
1722 function wfHostname() {
1724 if ( is_null( $host ) ) {
1726 # Hostname overriding
1727 global $wgOverrideHostname;
1728 if ( $wgOverrideHostname !== false ) {
1729 # Set static and skip any detection
1730 $host = $wgOverrideHostname;
1734 if ( function_exists( 'posix_uname' ) ) {
1735 // This function not present on Windows
1736 $uname = posix_uname();
1740 if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1741 $host = $uname['nodename'];
1742 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1743 # Windows computer name
1744 $host = getenv( 'COMPUTERNAME' );
1746 # This may be a virtual server.
1747 $host = $_SERVER['SERVER_NAME'];
1754 * Returns a HTML comment with the elapsed time since request.
1755 * This method has no side effects.
1759 function wfReportTime() {
1760 global $wgRequestTime, $wgShowHostnames;
1762 $elapsed = microtime( true ) - $wgRequestTime;
1764 return $wgShowHostnames
1765 ?
sprintf( '<!-- Served by %s in %01.3f secs. -->', wfHostname(), $elapsed )
1766 : sprintf( '<!-- Served in %01.3f secs. -->', $elapsed );
1770 * Safety wrapper for debug_backtrace().
1772 * With Zend Optimizer 3.2.0 loaded, this causes segfaults under somewhat
1773 * murky circumstances, which may be triggered in part by stub objects
1774 * or other fancy talking'.
1776 * Will return an empty array if Zend Optimizer is detected or if
1777 * debug_backtrace is disabled, otherwise the output from
1778 * debug_backtrace() (trimmed).
1780 * @param int $limit This parameter can be used to limit the number of stack frames returned
1782 * @return array of backtrace information
1784 function wfDebugBacktrace( $limit = 0 ) {
1785 static $disabled = null;
1787 if ( extension_loaded( 'Zend Optimizer' ) ) {
1788 wfDebug( "Zend Optimizer detected; skipping debug_backtrace for safety.\n" );
1792 if ( is_null( $disabled ) ) {
1794 $functions = explode( ',', ini_get( 'disable_functions' ) );
1795 $functions = array_map( 'trim', $functions );
1796 $functions = array_map( 'strtolower', $functions );
1797 if ( in_array( 'debug_backtrace', $functions ) ) {
1798 wfDebug( "debug_backtrace is in disabled_functions\n" );
1806 if ( $limit && version_compare( PHP_VERSION
, '5.4.0', '>=' ) ) {
1807 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, $limit +
1 ), 1 );
1809 return array_slice( debug_backtrace(), 1 );
1814 * Get a debug backtrace as a string
1818 function wfBacktrace() {
1819 global $wgCommandLineMode;
1821 if ( $wgCommandLineMode ) {
1826 $backtrace = wfDebugBacktrace();
1827 foreach ( $backtrace as $call ) {
1828 if ( isset( $call['file'] ) ) {
1829 $f = explode( DIRECTORY_SEPARATOR
, $call['file'] );
1830 $file = $f[count( $f ) - 1];
1834 if ( isset( $call['line'] ) ) {
1835 $line = $call['line'];
1839 if ( $wgCommandLineMode ) {
1840 $msg .= "$file line $line calls ";
1842 $msg .= '<li>' . $file . ' line ' . $line . ' calls ';
1844 if ( !empty( $call['class'] ) ) {
1845 $msg .= $call['class'] . $call['type'];
1847 $msg .= $call['function'] . '()';
1849 if ( $wgCommandLineMode ) {
1855 if ( $wgCommandLineMode ) {
1865 * Get the name of the function which called this function
1866 * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1867 * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1868 * wfGetCaller( 3 ) is the parent of that.
1873 function wfGetCaller( $level = 2 ) {
1874 $backtrace = wfDebugBacktrace( $level +
1 );
1875 if ( isset( $backtrace[$level] ) ) {
1876 return wfFormatStackFrame( $backtrace[$level] );
1883 * Return a string consisting of callers in the stack. Useful sometimes
1884 * for profiling specific points.
1886 * @param int $limit The maximum depth of the stack frame to return, or false for
1890 function wfGetAllCallers( $limit = 3 ) {
1891 $trace = array_reverse( wfDebugBacktrace() );
1892 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1893 $limit = count( $trace ) - 1;
1895 $trace = array_slice( $trace, -$limit - 1, $limit );
1896 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1900 * Return a string representation of frame
1902 * @param $frame Array
1905 function wfFormatStackFrame( $frame ) {
1906 return isset( $frame['class'] ) ?
1907 $frame['class'] . '::' . $frame['function'] :
1911 /* Some generic result counters, pulled out of SearchEngine */
1916 * @param $offset Int
1920 function wfShowingResults( $offset, $limit ) {
1921 return wfMessage( 'showingresults' )->numParams( $limit, $offset +
1 )->parse();
1925 * Generate (prev x| next x) (20|50|100...) type links for paging
1927 * @param $offset String
1928 * @param $limit Integer
1929 * @param $link String
1930 * @param string $query optional URL query parameter string
1931 * @param bool $atend optional param for specified if this is the last page
1933 * @deprecated in 1.19; use Language::viewPrevNext() instead
1935 function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
1936 wfDeprecated( __METHOD__
, '1.19' );
1940 $query = wfCgiToArray( $query );
1942 if ( is_object( $link ) ) {
1945 $title = Title
::newFromText( $link );
1946 if ( is_null( $title ) ) {
1951 return $wgLang->viewPrevNext( $title, $offset, $limit, $query, $atend );
1956 * @todo FIXME: We may want to blacklist some broken browsers
1958 * @param $force Bool
1959 * @return bool Whereas client accept gzip compression
1961 function wfClientAcceptsGzip( $force = false ) {
1962 static $result = null;
1963 if ( $result === null ||
$force ) {
1965 if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1966 # @todo FIXME: We may want to blacklist some broken browsers
1969 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1970 $_SERVER['HTTP_ACCEPT_ENCODING'],
1974 if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1978 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
1987 * Obtain the offset and limit values from the request string;
1988 * used in special pages
1990 * @param int $deflimit default limit if none supplied
1991 * @param string $optionname Name of a user preference to check against
1995 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
1997 return $wgRequest->getLimitOffset( $deflimit, $optionname );
2001 * Escapes the given text so that it may be output using addWikiText()
2002 * without any linking, formatting, etc. making its way through. This
2003 * is achieved by substituting certain characters with HTML entities.
2004 * As required by the callers, "<nowiki>" is not used.
2006 * @param string $text text to be escaped
2009 function wfEscapeWikiText( $text ) {
2010 static $repl = null, $repl2 = null;
2011 if ( $repl === null ) {
2013 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
2014 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
2015 '{' => '{', '|' => '|', '}' => '}', ';' => ';',
2016 "\n#" => "\n#", "\r#" => "\r#",
2017 "\n*" => "\n*", "\r*" => "\r*",
2018 "\n:" => "\n:", "\r:" => "\r:",
2019 "\n " => "\n ", "\r " => "\r ",
2020 "\n\n" => "\n ", "\r\n" => " \n",
2021 "\n\r" => "\n ", "\r\r" => "\r ",
2022 "\n\t" => "\n	", "\r\t" => "\r	", // "\n\t\n" is treated like "\n\n"
2023 "\n----" => "\n----", "\r----" => "\r----",
2024 '__' => '__', '://' => '://',
2027 // We have to catch everything "\s" matches in PCRE
2028 foreach ( array( 'ISBN', 'RFC', 'PMID' ) as $magic ) {
2029 $repl["$magic "] = "$magic ";
2030 $repl["$magic\t"] = "$magic	";
2031 $repl["$magic\r"] = "$magic ";
2032 $repl["$magic\n"] = "$magic ";
2033 $repl["$magic\f"] = "$magic";
2036 // And handle protocols that don't use "://"
2037 global $wgUrlProtocols;
2039 foreach ( $wgUrlProtocols as $prot ) {
2040 if ( substr( $prot, -1 ) === ':' ) {
2041 $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
2044 $repl2 = $repl2 ?
'/\b(' . join( '|', $repl2 ) . '):/i' : '/^(?!)/';
2046 $text = substr( strtr( "\n$text", $repl ), 1 );
2047 $text = preg_replace( $repl2, '$1:', $text );
2052 * Get the current unix timestamp with microseconds. Useful for profiling
2053 * @deprecated since 1.22; call microtime() directly
2057 wfDeprecated( __FUNCTION__
, '1.22' );
2058 return microtime( true );
2062 * Sets dest to source and returns the original value of dest
2063 * If source is NULL, it just returns the value, it doesn't set the variable
2064 * If force is true, it will set the value even if source is NULL
2066 * @param $dest Mixed
2067 * @param $source Mixed
2068 * @param $force Bool
2071 function wfSetVar( &$dest, $source, $force = false ) {
2073 if ( !is_null( $source ) ||
$force ) {
2080 * As for wfSetVar except setting a bit
2084 * @param $state Bool
2088 function wfSetBit( &$dest, $bit, $state = true ) {
2089 $temp = (bool)( $dest & $bit );
2090 if ( !is_null( $state ) ) {
2101 * A wrapper around the PHP function var_export().
2102 * Either print it or add it to the regular output ($wgOut).
2104 * @param $var mixed A PHP variable to dump.
2106 function wfVarDump( $var ) {
2108 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
2109 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
2112 $wgOut->addHTML( $s );
2117 * Provide a simple HTTP error.
2119 * @param $code Int|String
2120 * @param $label String
2121 * @param $desc String
2123 function wfHttpError( $code, $label, $desc ) {
2126 header( "HTTP/1.0 $code $label" );
2127 header( "Status: $code $label" );
2128 $wgOut->sendCacheControl();
2130 header( 'Content-type: text/html; charset=utf-8' );
2131 print "<!doctype html>" .
2132 '<html><head><title>' .
2133 htmlspecialchars( $label ) .
2134 '</title></head><body><h1>' .
2135 htmlspecialchars( $label ) .
2137 nl2br( htmlspecialchars( $desc ) ) .
2138 "</p></body></html>\n";
2142 * Clear away any user-level output buffers, discarding contents.
2144 * Suitable for 'starting afresh', for instance when streaming
2145 * relatively large amounts of data without buffering, or wanting to
2146 * output image files without ob_gzhandler's compression.
2148 * The optional $resetGzipEncoding parameter controls suppression of
2149 * the Content-Encoding header sent by ob_gzhandler; by default it
2150 * is left. See comments for wfClearOutputBuffers() for why it would
2153 * Note that some PHP configuration options may add output buffer
2154 * layers which cannot be removed; these are left in place.
2156 * @param $resetGzipEncoding Bool
2158 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
2159 if ( $resetGzipEncoding ) {
2160 // Suppress Content-Encoding and Content-Length
2161 // headers from 1.10+s wfOutputHandler
2162 global $wgDisableOutputCompression;
2163 $wgDisableOutputCompression = true;
2165 while ( $status = ob_get_status() ) {
2166 if ( $status['type'] == 0 /* PHP_OUTPUT_HANDLER_INTERNAL */ ) {
2167 // Probably from zlib.output_compression or other
2168 // PHP-internal setting which can't be removed.
2170 // Give up, and hope the result doesn't break
2174 if ( !ob_end_clean() ) {
2175 // Could not remove output buffer handler; abort now
2176 // to avoid getting in some kind of infinite loop.
2179 if ( $resetGzipEncoding ) {
2180 if ( $status['name'] == 'ob_gzhandler' ) {
2181 // Reset the 'Content-Encoding' field set by this handler
2182 // so we can start fresh.
2183 header_remove( 'Content-Encoding' );
2191 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
2193 * Clear away output buffers, but keep the Content-Encoding header
2194 * produced by ob_gzhandler, if any.
2196 * This should be used for HTTP 304 responses, where you need to
2197 * preserve the Content-Encoding header of the real result, but
2198 * also need to suppress the output of ob_gzhandler to keep to spec
2199 * and avoid breaking Firefox in rare cases where the headers and
2200 * body are broken over two packets.
2202 function wfClearOutputBuffers() {
2203 wfResetOutputBuffers( false );
2207 * Converts an Accept-* header into an array mapping string values to quality
2210 * @param $accept String
2211 * @param string $def default
2214 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
2215 # No arg means accept anything (per HTTP spec)
2217 return array( $def => 1.0 );
2222 $parts = explode( ',', $accept );
2224 foreach ( $parts as $part ) {
2225 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
2226 $values = explode( ';', trim( $part ) );
2228 if ( count( $values ) == 1 ) {
2229 $prefs[$values[0]] = 1.0;
2230 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
2231 $prefs[$values[0]] = floatval( $match[1] );
2239 * Checks if a given MIME type matches any of the keys in the given
2240 * array. Basic wildcards are accepted in the array keys.
2242 * Returns the matching MIME type (or wildcard) if a match, otherwise
2245 * @param $type String
2246 * @param $avail Array
2250 function mimeTypeMatch( $type, $avail ) {
2251 if ( array_key_exists( $type, $avail ) ) {
2254 $parts = explode( '/', $type );
2255 if ( array_key_exists( $parts[0] . '/*', $avail ) ) {
2256 return $parts[0] . '/*';
2257 } elseif ( array_key_exists( '*/*', $avail ) ) {
2266 * Returns the 'best' match between a client's requested internet media types
2267 * and the server's list of available types. Each list should be an associative
2268 * array of type to preference (preference is a float between 0.0 and 1.0).
2269 * Wildcards in the types are acceptable.
2271 * @param array $cprefs client's acceptable type list
2272 * @param array $sprefs server's offered types
2275 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
2276 * XXX: generalize to negotiate other stuff
2278 function wfNegotiateType( $cprefs, $sprefs ) {
2281 foreach ( array_keys( $sprefs ) as $type ) {
2282 $parts = explode( '/', $type );
2283 if ( $parts[1] != '*' ) {
2284 $ckey = mimeTypeMatch( $type, $cprefs );
2286 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
2291 foreach ( array_keys( $cprefs ) as $type ) {
2292 $parts = explode( '/', $type );
2293 if ( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
2294 $skey = mimeTypeMatch( $type, $sprefs );
2296 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2304 foreach ( array_keys( $combine ) as $type ) {
2305 if ( $combine[$type] > $bestq ) {
2307 $bestq = $combine[$type];
2315 * Reference-counted warning suppression
2319 function wfSuppressWarnings( $end = false ) {
2320 static $suppressCount = 0;
2321 static $originalLevel = false;
2324 if ( $suppressCount ) {
2326 if ( !$suppressCount ) {
2327 error_reporting( $originalLevel );
2331 if ( !$suppressCount ) {
2332 $originalLevel = error_reporting( E_ALL
& ~
( E_WARNING | E_NOTICE | E_USER_WARNING | E_USER_NOTICE | E_DEPRECATED | E_USER_DEPRECATED | E_STRICT
) );
2339 * Restore error level to previous value
2341 function wfRestoreWarnings() {
2342 wfSuppressWarnings( true );
2345 # Autodetect, convert and provide timestamps of various types
2348 * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
2350 define( 'TS_UNIX', 0 );
2353 * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
2355 define( 'TS_MW', 1 );
2358 * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
2360 define( 'TS_DB', 2 );
2363 * RFC 2822 format, for E-mail and HTTP headers
2365 define( 'TS_RFC2822', 3 );
2368 * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
2370 * This is used by Special:Export
2372 define( 'TS_ISO_8601', 4 );
2375 * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
2377 * @see http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
2378 * DateTime tag and page 36 for the DateTimeOriginal and
2379 * DateTimeDigitized tags.
2381 define( 'TS_EXIF', 5 );
2384 * Oracle format time.
2386 define( 'TS_ORACLE', 6 );
2389 * Postgres format time.
2391 define( 'TS_POSTGRES', 7 );
2394 * ISO 8601 basic format with no timezone: 19860209T200000Z. This is used by ResourceLoader
2396 define( 'TS_ISO_8601_BASIC', 9 );
2399 * Get a timestamp string in one of various formats
2401 * @param $outputtype Mixed: A timestamp in one of the supported formats, the
2402 * function will autodetect which format is supplied and act
2404 * @param $ts Mixed: optional timestamp to convert, default 0 for the current time
2405 * @return Mixed: String / false The same date in the format specified in $outputtype or false
2407 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
2409 $timestamp = new MWTimestamp( $ts );
2410 return $timestamp->getTimestamp( $outputtype );
2411 } catch ( TimestampException
$e ) {
2412 wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
2418 * Return a formatted timestamp, or null if input is null.
2419 * For dealing with nullable timestamp columns in the database.
2421 * @param $outputtype Integer
2425 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
2426 if ( is_null( $ts ) ) {
2429 return wfTimestamp( $outputtype, $ts );
2434 * Convenience function; returns MediaWiki timestamp for the present time.
2438 function wfTimestampNow() {
2440 return wfTimestamp( TS_MW
, time() );
2444 * Check if the operating system is Windows
2446 * @return Bool: true if it's Windows, False otherwise.
2448 function wfIsWindows() {
2449 static $isWindows = null;
2450 if ( $isWindows === null ) {
2451 $isWindows = substr( php_uname(), 0, 7 ) == 'Windows';
2457 * Check if we are running under HipHop
2461 function wfIsHipHop() {
2462 return defined( 'HPHP_VERSION' );
2466 * Swap two variables
2471 function swap( &$x, &$y ) {
2478 * Tries to get the system directory for temporary files. First
2479 * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
2480 * environment variables are then checked in sequence, and if none are
2481 * set try sys_get_temp_dir().
2483 * NOTE: When possible, use instead the tmpfile() function to create
2484 * temporary files to avoid race conditions on file creation, etc.
2488 function wfTempDir() {
2489 global $wgTmpDirectory;
2491 if ( $wgTmpDirectory !== false ) {
2492 return $wgTmpDirectory;
2495 $tmpDir = array_map( "getenv", array( 'TMPDIR', 'TMP', 'TEMP' ) );
2497 foreach ( $tmpDir as $tmp ) {
2498 if ( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
2502 return sys_get_temp_dir();
2506 * Make directory, and make all parent directories if they don't exist
2508 * @param string $dir full path to directory to create
2509 * @param $mode Integer: chmod value to use, default is $wgDirectoryMode
2510 * @param string $caller optional caller param for debugging.
2511 * @throws MWException
2514 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2515 global $wgDirectoryMode;
2517 if ( FileBackend
::isStoragePath( $dir ) ) { // sanity
2518 throw new MWException( __FUNCTION__
. " given storage path '$dir'." );
2521 if ( !is_null( $caller ) ) {
2522 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2525 if ( strval( $dir ) === '' ||
( file_exists( $dir ) && is_dir( $dir ) ) ) {
2529 $dir = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR
, $dir );
2531 if ( is_null( $mode ) ) {
2532 $mode = $wgDirectoryMode;
2535 // Turn off the normal warning, we're doing our own below
2536 wfSuppressWarnings();
2537 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2538 wfRestoreWarnings();
2541 //directory may have been created on another request since we last checked
2542 if ( is_dir( $dir ) ) {
2546 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2547 wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2553 * Remove a directory and all its content.
2554 * Does not hide error.
2556 function wfRecursiveRemoveDir( $dir ) {
2557 wfDebug( __FUNCTION__
. "( $dir )\n" );
2558 // taken from http://de3.php.net/manual/en/function.rmdir.php#98622
2559 if ( is_dir( $dir ) ) {
2560 $objects = scandir( $dir );
2561 foreach ( $objects as $object ) {
2562 if ( $object != "." && $object != ".." ) {
2563 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2564 wfRecursiveRemoveDir( $dir . '/' . $object );
2566 unlink( $dir . '/' . $object );
2576 * @param $nr Mixed: the number to format
2577 * @param $acc Integer: the number of digits after the decimal point, default 2
2578 * @param $round Boolean: whether or not to round the value, default true
2581 function wfPercent( $nr, $acc = 2, $round = true ) {
2582 $ret = sprintf( "%.${acc}f", $nr );
2583 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2587 * Find out whether or not a mixed variable exists in a string
2589 * @deprecated Just use str(i)pos
2590 * @param $needle String
2591 * @param $str String
2592 * @param $insensitive Boolean
2595 function in_string( $needle, $str, $insensitive = false ) {
2596 wfDeprecated( __METHOD__
, '1.21' );
2598 if ( $insensitive ) {
2602 return $func( $str, $needle ) !== false;
2606 * Safety wrapper around ini_get() for boolean settings.
2607 * The values returned from ini_get() are pre-normalized for settings
2608 * set via php.ini or php_flag/php_admin_flag... but *not*
2609 * for those set via php_value/php_admin_value.
2611 * It's fairly common for people to use php_value instead of php_flag,
2612 * which can leave you with an 'off' setting giving a false positive
2613 * for code that just takes the ini_get() return value as a boolean.
2615 * To make things extra interesting, setting via php_value accepts
2616 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2617 * Unrecognized values go false... again opposite PHP's own coercion
2618 * from string to bool.
2620 * Luckily, 'properly' set settings will always come back as '0' or '1',
2621 * so we only have to worry about them and the 'improper' settings.
2623 * I frickin' hate PHP... :P
2625 * @param $setting String
2628 function wfIniGetBool( $setting ) {
2629 $val = strtolower( ini_get( $setting ) );
2630 // 'on' and 'true' can't have whitespace around them, but '1' can.
2634 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2638 * Windows-compatible version of escapeshellarg()
2639 * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
2640 * function puts single quotes in regardless of OS.
2642 * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
2643 * earlier distro releases of PHP)
2648 function wfEscapeShellArg() {
2649 wfInitShellLocale();
2651 $args = func_get_args();
2654 foreach ( $args as $arg ) {
2661 if ( wfIsWindows() ) {
2662 // Escaping for an MSVC-style command line parser and CMD.EXE
2664 // * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
2665 // * http://technet.microsoft.com/en-us/library/cc723564.aspx
2668 // Double the backslashes before any double quotes. Escape the double quotes.
2669 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE
);
2672 foreach ( $tokens as $token ) {
2673 if ( $iteration %
2 == 1 ) {
2674 // Delimiter, a double quote preceded by zero or more slashes
2675 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
2676 } elseif ( $iteration %
4 == 2 ) {
2677 // ^ in $token will be outside quotes, need to be escaped
2678 $arg .= str_replace( '^', '^^', $token );
2679 } else { // $iteration % 4 == 0
2680 // ^ in $token will appear inside double quotes, so leave as is
2685 // Double the backslashes before the end of the string, because
2686 // we will soon add a quote
2688 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
2689 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
2692 // Add surrounding quotes
2693 $retVal .= '"' . $arg . '"';
2695 $retVal .= escapeshellarg( $arg );
2702 * Check if wfShellExec() is effectively disabled via php.ini config
2703 * @return bool|string False or one of (safemode,disabled)
2706 function wfShellExecDisabled() {
2707 static $disabled = null;
2708 if ( is_null( $disabled ) ) {
2710 if ( wfIniGetBool( 'safe_mode' ) ) {
2711 wfDebug( "wfShellExec can't run in safe_mode, PHP's exec functions are too broken.\n" );
2712 $disabled = 'safemode';
2714 $functions = explode( ',', ini_get( 'disable_functions' ) );
2715 $functions = array_map( 'trim', $functions );
2716 $functions = array_map( 'strtolower', $functions );
2717 if ( in_array( 'passthru', $functions ) ) {
2718 wfDebug( "passthru is in disabled_functions\n" );
2719 $disabled = 'passthru';
2727 * Execute a shell command, with time and memory limits mirrored from the PHP
2728 * configuration if supported.
2729 * @param string $cmd Command line, properly escaped for shell.
2730 * @param &$retval null|Mixed optional, will receive the program's exit code.
2731 * (non-zero is usually failure)
2732 * @param array $environ optional environment variables which should be
2733 * added to the executed command environment.
2734 * @param array $limits optional array with limits(filesize, memory, time, walltime)
2735 * this overwrites the global wgShellMax* limits.
2736 * @param array $options Array of options. Only one is "duplicateStderr" => true, which
2737 * Which duplicates stderr to stdout, including errors from limit.sh
2738 * @return string collected stdout as a string
2740 function wfShellExec( $cmd, &$retval = null, $environ = array(), $limits = array(), $options = array() ) {
2741 global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime,
2742 $wgMaxShellWallClockTime, $wgShellCgroup;
2744 $disabled = wfShellExecDisabled();
2747 return $disabled == 'safemode' ?
2748 'Unable to run external programs in safe mode.' :
2749 'Unable to run external programs, passthru() is disabled.';
2752 $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2754 wfInitShellLocale();
2757 foreach ( $environ as $k => $v ) {
2758 if ( wfIsWindows() ) {
2759 /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2760 * appear in the environment variable, so we must use carat escaping as documented in
2761 * http://technet.microsoft.com/en-us/library/cc723564.aspx
2762 * Note however that the quote isn't listed there, but is needed, and the parentheses
2763 * are listed there but doesn't appear to need it.
2765 $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2767 /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2768 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2770 $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2773 $cmd = $envcmd . $cmd;
2775 if ( php_uname( 's' ) == 'Linux' ) {
2776 $time = intval ( isset( $limits['time'] ) ?
$limits['time'] : $wgMaxShellTime );
2777 if ( isset( $limits['walltime'] ) ) {
2778 $wallTime = intval( $limits['walltime'] );
2779 } elseif ( isset( $limits['time'] ) ) {
2782 $wallTime = intval( $wgMaxShellWallClockTime );
2784 $mem = intval ( isset( $limits['memory'] ) ?
$limits['memory'] : $wgMaxShellMemory );
2785 $filesize = intval ( isset( $limits['filesize'] ) ?
$limits['filesize'] : $wgMaxShellFileSize );
2787 if ( $time > 0 ||
$mem > 0 ||
$filesize > 0 ||
$wallTime > 0 ) {
2788 $cmd = '/bin/bash ' . escapeshellarg( "$IP/includes/limit.sh" ) . ' ' .
2789 escapeshellarg( $cmd ) . ' ' .
2791 "MW_INCLUDE_STDERR=" . ( $includeStderr ?
'1' : '' ) . ';' .
2792 "MW_CPU_LIMIT=$time; " .
2793 'MW_CGROUP=' . escapeshellarg( $wgShellCgroup ) . '; ' .
2794 "MW_MEM_LIMIT=$mem; " .
2795 "MW_FILE_SIZE_LIMIT=$filesize; " .
2796 "MW_WALL_CLOCK_LIMIT=$wallTime"
2798 } elseif ( $includeStderr ) {
2801 } elseif ( $includeStderr ) {
2804 wfDebug( "wfShellExec: $cmd\n" );
2806 // Default to an unusual value that shouldn't happen naturally,
2807 // so in the unlikely event of a weird php bug, it would be
2808 // more obvious what happened.
2811 passthru( $cmd, $retval );
2812 $output = ob_get_contents();
2815 if ( $retval == 127 ) {
2816 wfDebugLog( 'exec', "Possibly missing executable file: $cmd\n" );
2822 * Execute a shell command, returning both stdout and stderr. Convenience
2823 * function, as all the arguments to wfShellExec can become unwieldy.
2825 * @note This also includes errors from limit.sh, e.g. if $wgMaxShellFileSize is exceeded.
2826 * @param string $cmd Command line, properly escaped for shell.
2827 * @param &$retval null|Mixed optional, will receive the program's exit code.
2828 * (non-zero is usually failure)
2829 * @param array $environ optional environment variables which should be
2830 * added to the executed command environment.
2831 * @param array $limits optional array with limits(filesize, memory, time, walltime)
2832 * this overwrites the global wgShellMax* limits.
2833 * @return string collected stdout and stderr as a string
2835 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = array(), $limits = array() ) {
2836 return wfShellExec( $cmd, $retval, $environ, $limits, array( 'duplicateStderr' => true ) );
2840 * Workaround for http://bugs.php.net/bug.php?id=45132
2841 * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
2843 function wfInitShellLocale() {
2844 static $done = false;
2849 global $wgShellLocale;
2850 if ( !wfIniGetBool( 'safe_mode' ) ) {
2851 putenv( "LC_CTYPE=$wgShellLocale" );
2852 setlocale( LC_CTYPE
, $wgShellLocale );
2857 * Alias to wfShellWikiCmd()
2858 * @see wfShellWikiCmd()
2860 function wfShellMaintenanceCmd( $script, array $parameters = array(), array $options = array() ) {
2861 return wfShellWikiCmd( $script, $parameters, $options );
2865 * Generate a shell-escaped command line string to run a MediaWiki cli script.
2866 * Note that $parameters should be a flat array and an option with an argument
2867 * should consist of two consecutive items in the array (do not use "--option value").
2868 * @param string $script MediaWiki cli script path
2869 * @param array $parameters Arguments and options to the script
2870 * @param array $options Associative array of options:
2871 * 'php': The path to the php executable
2872 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
2875 function wfShellWikiCmd( $script, array $parameters = array(), array $options = array() ) {
2877 // Give site config file a chance to run the script in a wrapper.
2878 // The caller may likely want to call wfBasename() on $script.
2879 wfRunHooks( 'wfShellWikiCmd', array( &$script, &$parameters, &$options ) );
2880 $cmd = isset( $options['php'] ) ?
array( $options['php'] ) : array( $wgPhpCli );
2881 if ( isset( $options['wrapper'] ) ) {
2882 $cmd[] = $options['wrapper'];
2885 // Escape each parameter for shell
2886 return implode( " ", array_map( 'wfEscapeShellArg', array_merge( $cmd, $parameters ) ) );
2890 * wfMerge attempts to merge differences between three texts.
2891 * Returns true for a clean merge and false for failure or a conflict.
2893 * @param $old String
2894 * @param $mine String
2895 * @param $yours String
2896 * @param $result String
2899 function wfMerge( $old, $mine, $yours, &$result ) {
2902 # This check may also protect against code injection in
2903 # case of broken installations.
2904 wfSuppressWarnings();
2905 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2906 wfRestoreWarnings();
2908 if ( !$haveDiff3 ) {
2909 wfDebug( "diff3 not found\n" );
2913 # Make temporary files
2915 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2916 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2917 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2919 # NOTE: diff3 issues a warning to stderr if any of the files does not end with
2920 # a newline character. To avoid this, we normalize the trailing whitespace before
2921 # creating the diff.
2923 fwrite( $oldtextFile, rtrim( $old ) . "\n" );
2924 fclose( $oldtextFile );
2925 fwrite( $mytextFile, rtrim( $mine ) . "\n" );
2926 fclose( $mytextFile );
2927 fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
2928 fclose( $yourtextFile );
2930 # Check for a conflict
2931 $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a --overlap-only ' .
2932 wfEscapeShellArg( $mytextName ) . ' ' .
2933 wfEscapeShellArg( $oldtextName ) . ' ' .
2934 wfEscapeShellArg( $yourtextName );
2935 $handle = popen( $cmd, 'r' );
2937 if ( fgets( $handle, 1024 ) ) {
2945 $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a -e --merge ' .
2946 wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
2947 $handle = popen( $cmd, 'r' );
2950 $data = fread( $handle, 8192 );
2951 if ( strlen( $data ) == 0 ) {
2957 unlink( $mytextName );
2958 unlink( $oldtextName );
2959 unlink( $yourtextName );
2961 if ( $result === '' && $old !== '' && !$conflict ) {
2962 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
2969 * Returns unified plain-text diff of two texts.
2970 * Useful for machine processing of diffs.
2972 * @param string $before the text before the changes.
2973 * @param string $after the text after the changes.
2974 * @param string $params command-line options for the diff command.
2975 * @return String: unified diff of $before and $after
2977 function wfDiff( $before, $after, $params = '-u' ) {
2978 if ( $before == $after ) {
2983 wfSuppressWarnings();
2984 $haveDiff = $wgDiff && file_exists( $wgDiff );
2985 wfRestoreWarnings();
2987 # This check may also protect against code injection in
2988 # case of broken installations.
2990 wfDebug( "diff executable not found\n" );
2991 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
2992 $format = new UnifiedDiffFormatter();
2993 return $format->format( $diffs );
2996 # Make temporary files
2998 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2999 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
3001 fwrite( $oldtextFile, $before );
3002 fclose( $oldtextFile );
3003 fwrite( $newtextFile, $after );
3004 fclose( $newtextFile );
3006 // Get the diff of the two files
3007 $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
3009 $h = popen( $cmd, 'r' );
3014 $data = fread( $h, 8192 );
3015 if ( strlen( $data ) == 0 ) {
3023 unlink( $oldtextName );
3024 unlink( $newtextName );
3026 // Kill the --- and +++ lines. They're not useful.
3027 $diff_lines = explode( "\n", $diff );
3028 if ( strpos( $diff_lines[0], '---' ) === 0 ) {
3029 unset( $diff_lines[0] );
3031 if ( strpos( $diff_lines[1], '+++' ) === 0 ) {
3032 unset( $diff_lines[1] );
3035 $diff = implode( "\n", $diff_lines );
3041 * This function works like "use VERSION" in Perl, the program will die with a
3042 * backtrace if the current version of PHP is less than the version provided
3044 * This is useful for extensions which due to their nature are not kept in sync
3045 * with releases, and might depend on other versions of PHP than the main code
3047 * Note: PHP might die due to parsing errors in some cases before it ever
3048 * manages to call this function, such is life
3050 * @see perldoc -f use
3052 * @param $req_ver Mixed: the version to check, can be a string, an integer, or
3054 * @throws MWException
3056 function wfUsePHP( $req_ver ) {
3057 $php_ver = PHP_VERSION
;
3059 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
3060 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
3065 * This function works like "use VERSION" in Perl except it checks the version
3066 * of MediaWiki, the program will die with a backtrace if the current version
3067 * of MediaWiki is less than the version provided.
3069 * This is useful for extensions which due to their nature are not kept in sync
3072 * @see perldoc -f use
3074 * @param $req_ver Mixed: the version to check, can be a string, an integer, or
3076 * @throws MWException
3078 function wfUseMW( $req_ver ) {
3081 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
3082 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
3087 * Return the final portion of a pathname.
3088 * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
3089 * http://bugs.php.net/bug.php?id=33898
3091 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
3092 * We'll consider it so always, as we don't want '\s' in our Unix paths either.
3094 * @param $path String
3095 * @param string $suffix to remove if present
3098 function wfBaseName( $path, $suffix = '' ) {
3099 $encSuffix = ( $suffix == '' )
3101 : ( '(?:' . preg_quote( $suffix, '#' ) . ')?' );
3103 if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
3111 * Generate a relative path name to the given file.
3112 * May explode on non-matching case-insensitive paths,
3113 * funky symlinks, etc.
3115 * @param string $path absolute destination path including target filename
3116 * @param string $from Absolute source path, directory only
3119 function wfRelativePath( $path, $from ) {
3120 // Normalize mixed input on Windows...
3121 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
3122 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
3124 // Trim trailing slashes -- fix for drive root
3125 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
3126 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
3128 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
3129 $against = explode( DIRECTORY_SEPARATOR
, $from );
3131 if ( $pieces[0] !== $against[0] ) {
3132 // Non-matching Windows drive letters?
3133 // Return a full path.
3137 // Trim off common prefix
3138 while ( count( $pieces ) && count( $against )
3139 && $pieces[0] == $against[0] ) {
3140 array_shift( $pieces );
3141 array_shift( $against );
3144 // relative dots to bump us to the parent
3145 while ( count( $against ) ) {
3146 array_unshift( $pieces, '..' );
3147 array_shift( $against );
3150 array_push( $pieces, wfBaseName( $path ) );
3152 return implode( DIRECTORY_SEPARATOR
, $pieces );
3156 * Do any deferred updates and clear the list
3158 * @deprecated since 1.19
3159 * @see DeferredUpdates::doUpdate()
3160 * @param $commit string
3162 function wfDoUpdates( $commit = '' ) {
3163 wfDeprecated( __METHOD__
, '1.19' );
3164 DeferredUpdates
::doUpdates( $commit );
3168 * Convert an arbitrarily-long digit string from one numeric base
3169 * to another, optionally zero-padding to a minimum column width.
3171 * Supports base 2 through 36; digit values 10-36 are represented
3172 * as lowercase letters a-z. Input is case-insensitive.
3174 * @param string $input Input number
3175 * @param int $sourceBase Base of the input number
3176 * @param int $destBase Desired base of the output
3177 * @param int $pad Minimum number of digits in the output (pad with zeroes)
3178 * @param bool $lowercase Whether to output in lowercase or uppercase
3179 * @param string $engine Either "gmp", "bcmath", or "php"
3180 * @return string|bool The output number as a string, or false on error
3182 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1, $lowercase = true, $engine = 'auto' ) {
3183 $input = (string)$input;
3189 $sourceBase != (int)$sourceBase ||
3190 $destBase != (int)$destBase ||
3191 $pad != (int)$pad ||
3192 !preg_match( "/^[" . substr( '0123456789abcdefghijklmnopqrstuvwxyz', 0, $sourceBase ) . "]+$/i", $input )
3197 static $baseChars = array(
3198 10 => 'a', 11 => 'b', 12 => 'c', 13 => 'd', 14 => 'e', 15 => 'f',
3199 16 => 'g', 17 => 'h', 18 => 'i', 19 => 'j', 20 => 'k', 21 => 'l',
3200 22 => 'm', 23 => 'n', 24 => 'o', 25 => 'p', 26 => 'q', 27 => 'r',
3201 28 => 's', 29 => 't', 30 => 'u', 31 => 'v', 32 => 'w', 33 => 'x',
3202 34 => 'y', 35 => 'z',
3204 '0' => 0, '1' => 1, '2' => 2, '3' => 3, '4' => 4, '5' => 5,
3205 '6' => 6, '7' => 7, '8' => 8, '9' => 9, 'a' => 10, 'b' => 11,
3206 'c' => 12, 'd' => 13, 'e' => 14, 'f' => 15, 'g' => 16, 'h' => 17,
3207 'i' => 18, 'j' => 19, 'k' => 20, 'l' => 21, 'm' => 22, 'n' => 23,
3208 'o' => 24, 'p' => 25, 'q' => 26, 'r' => 27, 's' => 28, 't' => 29,
3209 'u' => 30, 'v' => 31, 'w' => 32, 'x' => 33, 'y' => 34, 'z' => 35
3212 if ( extension_loaded( 'gmp' ) && ( $engine == 'auto' ||
$engine == 'gmp' ) ) {
3213 $result = gmp_strval( gmp_init( $input, $sourceBase ), $destBase );
3214 } elseif ( extension_loaded( 'bcmath' ) && ( $engine == 'auto' ||
$engine == 'bcmath' ) ) {
3216 foreach ( str_split( strtolower( $input ) ) as $char ) {
3217 $decimal = bcmul( $decimal, $sourceBase );
3218 $decimal = bcadd( $decimal, $baseChars[$char] );
3221 for ( $result = ''; bccomp( $decimal, 0 ); $decimal = bcdiv( $decimal, $destBase, 0 ) ) {
3222 $result .= $baseChars[bcmod( $decimal, $destBase )];
3225 $result = strrev( $result );
3227 $inDigits = array();
3228 foreach ( str_split( strtolower( $input ) ) as $char ) {
3229 $inDigits[] = $baseChars[$char];
3232 // Iterate over the input, modulo-ing out an output digit
3233 // at a time until input is gone.
3235 while ( $inDigits ) {
3237 $workDigits = array();
3240 foreach ( $inDigits as $digit ) {
3241 $work *= $sourceBase;
3244 if ( $workDigits ||
$work >= $destBase ) {
3245 $workDigits[] = (int)( $work / $destBase );
3250 // All that division leaves us with a remainder,
3251 // which is conveniently our next output digit.
3252 $result .= $baseChars[$work];
3255 $inDigits = $workDigits;
3258 $result = strrev( $result );
3261 if ( !$lowercase ) {
3262 $result = strtoupper( $result );
3265 return str_pad( $result, $pad, '0', STR_PAD_LEFT
);
3269 * Create an object with a given name and an array of construct parameters
3271 * @param $name String
3272 * @param array $p parameters
3274 * @deprecated since 1.18, warnings in 1.18, removal in 1.20
3276 function wfCreateObject( $name, $p ) {
3277 wfDeprecated( __FUNCTION__
, '1.18' );
3278 return MWFunction
::newObj( $name, $p );
3284 function wfHttpOnlySafe() {
3285 global $wgHttpOnlyBlacklist;
3287 if ( isset( $_SERVER['HTTP_USER_AGENT'] ) ) {
3288 foreach ( $wgHttpOnlyBlacklist as $regex ) {
3289 if ( preg_match( $regex, $_SERVER['HTTP_USER_AGENT'] ) ) {
3299 * Check if there is sufficient entropy in php's built-in session generation
3300 * @return bool true = there is sufficient entropy
3302 function wfCheckEntropy() {
3304 ( wfIsWindows() && version_compare( PHP_VERSION
, '5.3.3', '>=' ) )
3305 ||
ini_get( 'session.entropy_file' )
3307 && intval( ini_get( 'session.entropy_length' ) ) >= 32;
3311 * Override session_id before session startup if php's built-in
3312 * session generation code is not secure.
3314 function wfFixSessionID() {
3315 // If the cookie or session id is already set we already have a session and should abort
3316 if ( isset( $_COOKIE[session_name()] ) ||
session_id() ) {
3320 // PHP's built-in session entropy is enabled if:
3321 // - entropy_file is set or you're on Windows with php 5.3.3+
3322 // - AND entropy_length is > 0
3323 // We treat it as disabled if it doesn't have an entropy length of at least 32
3324 $entropyEnabled = wfCheckEntropy();
3326 // If built-in entropy is not enabled or not sufficient override php's built in session id generation code
3327 if ( !$entropyEnabled ) {
3328 wfDebug( __METHOD__
. ": PHP's built in entropy is disabled or not sufficient, overriding session id generation using our cryptrand source.\n" );
3329 session_id( MWCryptRand
::generateHex( 32 ) );
3334 * Reset the session_id
3337 function wfResetSessionID() {
3338 global $wgCookieSecure;
3339 $oldSessionId = session_id();
3340 $cookieParams = session_get_cookie_params();
3341 if ( wfCheckEntropy() && $wgCookieSecure == $cookieParams['secure'] ) {
3342 session_regenerate_id( false );
3346 wfSetupSession( MWCryptRand
::generateHex( 32 ) );
3349 $newSessionId = session_id();
3350 wfRunHooks( 'ResetSessionID', array( $oldSessionId, $newSessionId ) );
3355 * Initialise php session
3357 * @param $sessionId Bool
3359 function wfSetupSession( $sessionId = false ) {
3360 global $wgSessionsInMemcached, $wgSessionsInObjectCache, $wgCookiePath, $wgCookieDomain,
3361 $wgCookieSecure, $wgCookieHttpOnly, $wgSessionHandler;
3362 if ( $wgSessionsInObjectCache ||
$wgSessionsInMemcached ) {
3363 ObjectCacheSessionHandler
::install();
3364 } elseif ( $wgSessionHandler && $wgSessionHandler != ini_get( 'session.save_handler' ) ) {
3365 # Only set this if $wgSessionHandler isn't null and session.save_handler
3366 # hasn't already been set to the desired value (that causes errors)
3367 ini_set( 'session.save_handler', $wgSessionHandler );
3369 $httpOnlySafe = wfHttpOnlySafe() && $wgCookieHttpOnly;
3370 wfDebugLog( 'cookie',
3371 'session_set_cookie_params: "' . implode( '", "',
3377 $httpOnlySafe ) ) . '"' );
3378 session_set_cookie_params( 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $httpOnlySafe );
3379 session_cache_limiter( 'private, must-revalidate' );
3381 session_id( $sessionId );
3385 wfSuppressWarnings();
3387 wfRestoreWarnings();
3391 * Get an object from the precompiled serialized directory
3393 * @param $name String
3394 * @return Mixed: the variable on success, false on failure
3396 function wfGetPrecompiledData( $name ) {
3399 $file = "$IP/serialized/$name";
3400 if ( file_exists( $file ) ) {
3401 $blob = file_get_contents( $file );
3403 return unserialize( $blob );
3415 function wfMemcKey( /*... */ ) {
3416 global $wgCachePrefix;
3417 $prefix = $wgCachePrefix === false ?
wfWikiID() : $wgCachePrefix;
3418 $args = func_get_args();
3419 $key = $prefix . ':' . implode( ':', $args );
3420 $key = str_replace( ' ', '_', $key );
3425 * Get a cache key for a foreign DB
3428 * @param $prefix String
3429 * @param varargs String
3432 function wfForeignMemcKey( $db, $prefix /*, ... */ ) {
3433 $args = array_slice( func_get_args(), 2 );
3435 $key = "$db-$prefix:" . implode( ':', $args );
3437 $key = $db . ':' . implode( ':', $args );
3439 return str_replace( ' ', '_', $key );
3443 * Get an ASCII string identifying this wiki
3444 * This is used as a prefix in memcached keys
3448 function wfWikiID() {
3449 global $wgDBprefix, $wgDBname;
3450 if ( $wgDBprefix ) {
3451 return "$wgDBname-$wgDBprefix";
3458 * Split a wiki ID into DB name and table prefix
3460 * @param $wiki String
3464 function wfSplitWikiID( $wiki ) {
3465 $bits = explode( '-', $wiki, 2 );
3466 if ( count( $bits ) < 2 ) {
3473 * Get a Database object.
3475 * @param $db Integer: index of the connection to get. May be DB_MASTER for the
3476 * master (for write queries), DB_SLAVE for potentially lagged read
3477 * queries, or an integer >= 0 for a particular server.
3479 * @param $groups Mixed: query groups. An array of group names that this query
3480 * belongs to. May contain a single string if the query is only
3483 * @param string $wiki the wiki ID, or false for the current wiki
3485 * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request
3486 * will always return the same object, unless the underlying connection or load
3487 * balancer is manually destroyed.
3489 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
3490 * updater to ensure that a proper database is being updated.
3492 * @return DatabaseBase
3494 function &wfGetDB( $db, $groups = array(), $wiki = false ) {
3495 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
3499 * Get a load balancer object.
3501 * @param string $wiki wiki ID, or false for the current wiki
3502 * @return LoadBalancer
3504 function wfGetLB( $wiki = false ) {
3505 return wfGetLBFactory()->getMainLB( $wiki );
3509 * Get the load balancer factory object
3513 function &wfGetLBFactory() {
3514 return LBFactory
::singleton();
3519 * Shortcut for RepoGroup::singleton()->findFile()
3521 * @param string $title or Title object
3522 * @param array $options Associative array of options:
3523 * time: requested time for an archived image, or false for the
3524 * current version. An image object will be returned which was
3525 * created at the specified time.
3527 * ignoreRedirect: If true, do not follow file redirects
3529 * private: If true, return restricted (deleted) files if the current
3530 * user is allowed to view them. Otherwise, such files will not
3533 * bypassCache: If true, do not use the process-local cache of File objects
3535 * @return File, or false if the file does not exist
3537 function wfFindFile( $title, $options = array() ) {
3538 return RepoGroup
::singleton()->findFile( $title, $options );
3542 * Get an object referring to a locally registered file.
3543 * Returns a valid placeholder object if the file does not exist.
3545 * @param $title Title|String
3546 * @return LocalFile|null A File, or null if passed an invalid Title
3548 function wfLocalFile( $title ) {
3549 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
3553 * Stream a file to the browser. Back-compat alias for StreamFile::stream()
3554 * @deprecated since 1.19
3556 function wfStreamFile( $fname, $headers = array() ) {
3557 wfDeprecated( __FUNCTION__
, '1.19' );
3558 StreamFile
::stream( $fname, $headers );
3562 * Should low-performance queries be disabled?
3565 * @codeCoverageIgnore
3567 function wfQueriesMustScale() {
3568 global $wgMiserMode;
3570 ||
( SiteStats
::pages() > 100000
3571 && SiteStats
::edits() > 1000000
3572 && SiteStats
::users() > 10000 );
3576 * Get the path to a specified script file, respecting file
3577 * extensions; this is a wrapper around $wgScriptExtension etc.
3578 * except for 'index' and 'load' which use $wgScript/$wgLoadScript
3580 * @param string $script script filename, sans extension
3583 function wfScript( $script = 'index' ) {
3584 global $wgScriptPath, $wgScriptExtension, $wgScript, $wgLoadScript;
3585 if ( $script === 'index' ) {
3587 } elseif ( $script === 'load' ) {
3588 return $wgLoadScript;
3590 return "{$wgScriptPath}/{$script}{$wgScriptExtension}";
3595 * Get the script URL.
3597 * @return string script URL
3599 function wfGetScriptUrl() {
3600 if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3602 # as it was called, minus the query string.
3604 # Some sites use Apache rewrite rules to handle subdomains,
3605 # and have PHP set up in a weird way that causes PHP_SELF
3606 # to contain the rewritten URL instead of the one that the
3607 # outside world sees.
3609 # If in this mode, use SCRIPT_URL instead, which mod_rewrite
3610 # provides containing the "before" URL.
3611 return $_SERVER['SCRIPT_NAME'];
3613 return $_SERVER['URL'];
3618 * Convenience function converts boolean values into "true"
3619 * or "false" (string) values
3621 * @param $value Boolean
3624 function wfBoolToStr( $value ) {
3625 return $value ?
'true' : 'false';
3629 * Get a platform-independent path to the null file, e.g. /dev/null
3633 function wfGetNull() {
3634 return wfIsWindows()
3640 * Modern version of wfWaitForSlaves(). Instead of looking at replication lag
3641 * and waiting for it to go down, this waits for the slaves to catch up to the
3642 * master position. Use this when updating very large numbers of rows, as
3643 * in maintenance scripts, to avoid causing too much lag. Of course, this is
3644 * a no-op if there are no slaves.
3646 * @param $maxLag Integer (deprecated)
3647 * @param $wiki mixed Wiki identifier accepted by wfGetLB
3648 * @param $cluster string cluster name accepted by LBFactory
3650 function wfWaitForSlaves( $maxLag = false, $wiki = false, $cluster = false ) {
3651 $lb = ( $cluster !== false )
3652 ?
wfGetLBFactory()->getExternalLB( $cluster )
3654 // bug 27975 - Don't try to wait for slaves if there are none
3655 // Prevents permission error when getting master position
3656 if ( $lb->getServerCount() > 1 ) {
3657 $dbw = $lb->getConnection( DB_MASTER
, array(), $wiki );
3658 $pos = $dbw->getMasterPos();
3659 // The DBMS may not support getMasterPos() or the whole
3660 // load balancer might be fake (e.g. $wgAllDBsAreLocalhost).
3661 if ( $pos !== false ) {
3662 $lb->waitForAll( $pos );
3668 * Used to be used for outputting text in the installer/updater
3669 * @deprecated since 1.18, warnings in 1.18, remove in 1.20
3671 function wfOut( $s ) {
3672 wfDeprecated( __FUNCTION__
, '1.18' );
3673 global $wgCommandLineMode;
3674 if ( $wgCommandLineMode ) {
3677 echo htmlspecialchars( $s );
3683 * Count down from $n to zero on the terminal, with a one-second pause
3684 * between showing each number. For use in command-line scripts.
3685 * @codeCoverageIgnore
3688 function wfCountDown( $n ) {
3689 for ( $i = $n; $i >= 0; $i-- ) {
3691 echo str_repeat( "\x08", strlen( $i +
1 ) );
3703 * Generate a random 32-character hexadecimal token.
3704 * @param $salt Mixed: some sort of salt, if necessary, to add to random
3705 * characters before hashing.
3707 * @codeCoverageIgnore
3708 * @deprecated since 1.20; Please use MWCryptRand for security purposes and wfRandomString for pseudo-random strings
3709 * @warning This method is NOT secure. Additionally it has many callers that use it for pseudo-random purposes.
3711 function wfGenerateToken( $salt = '' ) {
3712 wfDeprecated( __METHOD__
, '1.20' );
3713 $salt = serialize( $salt );
3714 return md5( mt_rand( 0, 0x7fffffff ) . $salt );
3718 * Replace all invalid characters with -
3719 * Additional characters can be defined in $wgIllegalFileChars (see bug 20489)
3720 * By default, $wgIllegalFileChars = ':'
3722 * @param $name Mixed: filename to process
3725 function wfStripIllegalFilenameChars( $name ) {
3726 global $wgIllegalFileChars;
3727 $illegalFileChars = $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '';
3728 $name = wfBaseName( $name );
3729 $name = preg_replace(
3730 "/[^" . Title
::legalChars() . "]" . $illegalFileChars . "/",
3738 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit;
3740 * @return Integer value memory was set to.
3742 function wfMemoryLimit() {
3743 global $wgMemoryLimit;
3744 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3745 if ( $memlimit != -1 ) {
3746 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3747 if ( $conflimit == -1 ) {
3748 wfDebug( "Removing PHP's memory limit\n" );
3749 wfSuppressWarnings();
3750 ini_set( 'memory_limit', $conflimit );
3751 wfRestoreWarnings();
3753 } elseif ( $conflimit > $memlimit ) {
3754 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3755 wfSuppressWarnings();
3756 ini_set( 'memory_limit', $conflimit );
3757 wfRestoreWarnings();
3765 * Converts shorthand byte notation to integer form
3767 * @param $string String
3770 function wfShorthandToInteger( $string = '' ) {
3771 $string = trim( $string );
3772 if ( $string === '' ) {
3775 $last = $string[strlen( $string ) - 1];
3776 $val = intval( $string );
3781 // break intentionally missing
3785 // break intentionally missing
3795 * Get the normalised IETF language tag
3796 * See unit test for examples.
3798 * @param string $code The language code.
3799 * @return String: The language code which complying with BCP 47 standards.
3801 function wfBCP47( $code ) {
3802 $codeSegment = explode( '-', $code );
3804 foreach ( $codeSegment as $segNo => $seg ) {
3805 // when previous segment is x, it is a private segment and should be lc
3806 if ( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
3807 $codeBCP[$segNo] = strtolower( $seg );
3808 // ISO 3166 country code
3809 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3810 $codeBCP[$segNo] = strtoupper( $seg );
3811 // ISO 15924 script code
3812 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3813 $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3814 // Use lowercase for other cases
3816 $codeBCP[$segNo] = strtolower( $seg );
3819 $langCode = implode( '-', $codeBCP );
3824 * Get a cache object.
3826 * @param $inputType integer Cache type, one the the CACHE_* constants.
3829 function wfGetCache( $inputType ) {
3830 return ObjectCache
::getInstance( $inputType );
3834 * Get the main cache object
3838 function wfGetMainCache() {
3839 global $wgMainCacheType;
3840 return ObjectCache
::getInstance( $wgMainCacheType );
3844 * Get the cache object used by the message cache
3848 function wfGetMessageCacheStorage() {
3849 global $wgMessageCacheType;
3850 return ObjectCache
::getInstance( $wgMessageCacheType );
3854 * Get the cache object used by the parser cache
3858 function wfGetParserCacheStorage() {
3859 global $wgParserCacheType;
3860 return ObjectCache
::getInstance( $wgParserCacheType );
3864 * Get the cache object used by the language converter
3868 function wfGetLangConverterCacheStorage() {
3869 global $wgLanguageConverterCacheType;
3870 return ObjectCache
::getInstance( $wgLanguageConverterCacheType );
3874 * Call hook functions defined in $wgHooks
3876 * @param string $event event name
3877 * @param array $args parameters passed to hook functions
3878 * @return Boolean True if no handler aborted the hook
3880 function wfRunHooks( $event, array $args = array() ) {
3881 return Hooks
::run( $event, $args );
3885 * Wrapper around php's unpack.
3887 * @param string $format The format string (See php's docs)
3888 * @param $data: A binary string of binary data
3889 * @param $length integer or false: The minimum length of $data. This is to
3890 * prevent reading beyond the end of $data. false to disable the check.
3892 * Also be careful when using this function to read unsigned 32 bit integer
3893 * because php might make it negative.
3895 * @throws MWException if $data not long enough, or if unpack fails
3896 * @return array Associative array of the extracted data
3898 function wfUnpack( $format, $data, $length = false ) {
3899 if ( $length !== false ) {
3900 $realLen = strlen( $data );
3901 if ( $realLen < $length ) {
3902 throw new MWException( "Tried to use wfUnpack on a "
3903 . "string of length $realLen, but needed one "
3904 . "of at least length $length."
3909 wfSuppressWarnings();
3910 $result = unpack( $format, $data );
3911 wfRestoreWarnings();
3913 if ( $result === false ) {
3914 // If it cannot extract the packed data.
3915 throw new MWException( "unpack could not unpack binary data" );
3921 * Determine if an image exists on the 'bad image list'.
3923 * The format of MediaWiki:Bad_image_list is as follows:
3924 * * Only list items (lines starting with "*") are considered
3925 * * The first link on a line must be a link to a bad image
3926 * * Any subsequent links on the same line are considered to be exceptions,
3927 * i.e. articles where the image may occur inline.
3929 * @param string $name the image name to check
3930 * @param $contextTitle Title|bool the page on which the image occurs, if known
3931 * @param string $blacklist wikitext of a file blacklist
3934 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
3935 static $badImageCache = null; // based on bad_image_list msg
3936 wfProfileIn( __METHOD__
);
3939 $redirectTitle = RepoGroup
::singleton()->checkRedirect( Title
::makeTitle( NS_FILE
, $name ) );
3940 if ( $redirectTitle ) {
3941 $name = $redirectTitle->getDBkey();
3944 # Run the extension hook
3946 if ( !wfRunHooks( 'BadImage', array( $name, &$bad ) ) ) {
3947 wfProfileOut( __METHOD__
);
3951 $cacheable = ( $blacklist === null );
3952 if ( $cacheable && $badImageCache !== null ) {
3953 $badImages = $badImageCache;
3954 } else { // cache miss
3955 if ( $blacklist === null ) {
3956 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
3958 # Build the list now
3959 $badImages = array();
3960 $lines = explode( "\n", $blacklist );
3961 foreach ( $lines as $line ) {
3963 if ( substr( $line, 0, 1 ) !== '*' ) {
3969 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
3973 $exceptions = array();
3974 $imageDBkey = false;
3975 foreach ( $m[1] as $i => $titleText ) {
3976 $title = Title
::newFromText( $titleText );
3977 if ( !is_null( $title ) ) {
3979 $imageDBkey = $title->getDBkey();
3981 $exceptions[$title->getPrefixedDBkey()] = true;
3986 if ( $imageDBkey !== false ) {
3987 $badImages[$imageDBkey] = $exceptions;
3991 $badImageCache = $badImages;
3995 $contextKey = $contextTitle ?
$contextTitle->getPrefixedDBkey() : false;
3996 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
3997 wfProfileOut( __METHOD__
);
4002 * Determine whether the client at a given source IP is likely to be able to
4003 * access the wiki via HTTPS.
4005 * @param string $ip The IPv4/6 address in the normal human-readable form
4008 function wfCanIPUseHTTPS( $ip ) {
4010 wfRunHooks( 'CanIPUseHTTPS', array( $ip, &$canDo ) );